Skip to content

Site

Site provides tools for creating, listing, retrieving, and updating resources in F5 Distributed Cloud.

ToolDescription
f5xc-api-sites-site-createSite Topology.
f5xc-api-sites-site-getGet Site.
f5xc-api-sites-site-listList Site.
f5xc-api-sites-site-updateUpdate Site.
ParameterDescriptionExample
siteSite Name of the site.-
nameName The name of the configuration object to be fetched.example-resource
namespaceNamespace The namespace in which the configuration object is present.system
ParameterDescriptionExample
response_formatThe format in which the configuration object is to be fetched. This could be for example - in GetSpec form for the contents of object…GET_RSP_FORMAT_DEFAULT
label_filterA LabelSelectorType expression that every item in list response will satisfy.-
report_fieldsThe report_fields parameter…-
report_status_fieldsThe report_status_fields parameter…-

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/$${PARAM}/sites" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/sites/$${PARAM}" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Create resource
curl -X POST "https://${TENANT}.console.ves.volterra.io/api/data/namespaces/system/topology/site/${PARAM}" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json" \
-d @site.json