Skip to content

App API Group

App API Group provides tools for creating, listing, retrieving, updating, and deleting resources in F5 Distributed Cloud.

ToolDescription
f5xc-api-api-app-api-group-createCreate API Group.
f5xc-api-api-app-api-group-getGet API Group.
f5xc-api-api-app-api-group-listList App API Group.
f5xc-api-api-app-api-group-updateUpdate API Group.
f5xc-api-api-app-api-group-deleteDelete App API Group.
ParameterDescriptionExample
namespaceNamespace This defines the workspace within which each the configuration object is to be created.system
nameName The name of the configuration object to be fetched.example-resource
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.bigip_virtual_serverBigip virtual server
spec.cdn_loadbalancerCdn loadbalancer
spec.http_loadbalancerHttp loadbalancer

Ask Claude to help you work with App API Group resources:

“Create a app-api-group named ‘example’ in the ‘production’ namespace”

“List all app-api-groups in the ‘production’ namespace”

“Get details of the app-api-group named ‘example’ in namespace ‘production‘“

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