Data Group¶
High Risk Operation
This resource includes operations that may cause significant changes. Review carefully before executing.
Confirmation Required
Some operations on this resource require explicit confirmation before execution.
Create data group in a given namespace. If one already exists it will give an error.
Tools¶
| Tool | Description |
|---|---|
f5xc-api-bigip-data-group-create | Create Data group. |
f5xc-api-bigip-data-group-get | GET Data Group. |
f5xc-api-bigip-data-group-list | List Data Group. |
f5xc-api-bigip-data-group-update | Replace Data Group. |
f5xc-api-bigip-data-group-delete | DELETE Data Group. |
Parameters¶
Path Parameters¶
| Parameter | Description | Example |
|---|---|---|
metadata.namespace | Namespace | - |
name | Name | - |
namespace | Namespace | - |
metadata.name | Name | - |
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 | - |
Side Effects¶
Operations on this resource may have the following effects:
Creates:
- data-group
Modifies:
- data-group
Deletes:
- data-group
- contained_resources
Example Usage¶
Ask Claude to help you work with Data Group resources:
Create Data Group¶
"Create a data-group named 'example' in the 'production' namespace"
List Data Groups¶
"List all data-groups in the 'production' namespace"
Get Data Group Details¶
"Get details of the data-group named 'example' in namespace 'production'"
CURL Examples¶
# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/data_groups" \
-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}/data_groups/<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}/data_groups" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json" \
-d @data_group.json
# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/data_groups/<name>" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}"