Skip to content

Cloud Region

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

ToolDescription
f5xc-api-cloudinfrastructure-cloud-region-getGet Cloud Region.
f5xc-api-cloudinfrastructure-cloud-region-listList Cloud Region.
f5xc-api-cloudinfrastructure-cloud-region-updateUpdate Cloud Region.
ParameterDescriptionExample
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…-

This resource includes mutually exclusive configuration options:

OptionDescriptionRecommended
spec.default_policy_groupDefault policy group
spec.policy_groupPolicy group

Ask Claude to help you work with Cloud Region resources:

“List all cloud-regions in the ‘production’ namespace”

“Get details of the cloud-region named ‘example’ in namespace ‘production‘“

Terminal window
# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/cloud_regions" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/cloud_regions/$${PARAM}" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}"