Skip to content

API Group Element

GET api_group_element reads a given object from storage backend for metadata.namespace.

ToolDescription
f5xc-api-api-api-group-element-getGET API Group Element.
f5xc-api-api-api-group-element-listList API Group Element.
ParameterDescriptionExample
nameName-
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-

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

“List all api-group-elements in the ‘production’ namespace”

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

Terminal window
# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/api_group_elements" \
-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}/api_group_elements/<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}/api_group_elements" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json" \
-d @api_group_element.json
# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/api_group_elements/<name>" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}"