API Group Element¶
Low Risk
Operations on this resource are generally safe.
GET api_group_element reads a given object from storage backend for metadata.namespace.
Tools¶
| Tool | Description |
|---|---|
f5xc-api-api-api-group-element-get | GET API Group Element. |
f5xc-api-api-api-group-element-list | List API Group Element. |
Parameters¶
Path Parameters¶
| Parameter | Description | Example |
|---|---|---|
name | Name | - |
namespace | Namespace | - |
Query Parameters¶
| Parameter | Description | Example |
|---|---|---|
response_format | The format in which the configuration object is to be fetched. This could be for example | - |
label_filter | A LabelSelectorType expression that every item in list response will satisfy. | - |
report_fields | The report_fields parameter | - |
report_status_fields | The report_status_fields parameter | - |
Example Usage¶
Ask Claude to help you work with API Group Element resources:
List API Group Elements¶
"List all api-group-elements in the 'production' namespace"
Get API Group Element Details¶
"Get details of the api-group-element named 'example' in namespace 'production'"
CURL Examples¶
# 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}"