Skip to content

Site

GET topology of a site and the resources associated/connected to the site such as other Customer sites, Regional Sites, VPCs (Virtual Private Cloud) networks, etc., and the associated metrics.

ToolDescription
f5xc-api-sites-site-createSite Topology.
f5xc-api-sites-site-getGET Site
f5xc-api-sites-site-listList Site
f5xc-api-sites-site-updateReplace Site.
ParameterDescriptionExample
siteSite-
nameName-
namespaceNamespace-
metadata.nameName-
metadata.namespaceNamespace-
ParameterDescriptionExample
response_formatThe format in which the configuration object is to be fetched. This could be for example-
label_filterA LabelSelectorType expression that every item in list response will satisfy.-
report_fieldsThe report_fields parameter-
report_status_fieldsThe report_status_fields parameter-

This resource includes mutually exclusive configuration options:

OptionDescriptionRecommended
spec.default_underlay_network.site_local_inside-
spec.default_underlay_network.site_local_outside-
OptionDescriptionRecommended
spec.kubernetes_upgrade_drain.disable_upgrade_drain-
spec.kubernetes_upgrade_drain.enable_upgrade_drain-
OptionDescriptionRecommended
spec.kubernetes_upgrade_drain.enable_upgrade_drain.drain_max_unavailable_node_count-
OptionDescriptionRecommended
spec.kubernetes_upgrade_drain.enable_upgrade_drain.disable_vega_upgrade_mode-
spec.kubernetes_upgrade_drain.enable_upgrade_drain.enable_vega_upgrade_mode-

Ask Claude to help you work with Site resources:

“Create a site named ‘example’ in the ‘production’ namespace”

“List all sites in the ‘production’ namespace”

“Get details of the site named ‘example’ in namespace ‘production‘“

Terminal window
# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/sites" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json"
# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/sites/<name>" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json"
# Create resource
curl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/sites" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json" \
-d @site.json
# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/sites/<name>" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}"