App API Group
App API Group provides tools for creating, listing, retrieving, updating, and deleting resources in F5 Distributed Cloud.
| Tool | Description |
|---|---|
f5xc-api-api-app-api-group-create | Create API Group. |
f5xc-api-api-app-api-group-get | Get API Group. |
f5xc-api-api-app-api-group-list | List App API Group. |
f5xc-api-api-app-api-group-update | Update API Group. |
f5xc-api-api-app-api-group-delete | Delete App API Group. |
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”| Parameter | Description | Example |
|---|---|---|
namespace | Namespace This defines the workspace within which each the configuration object is to be created. | system |
name | Name The name of the configuration object to be fetched. | example-resource |
Query Parameters
Section titled “Query Parameters”| Parameter | Description | Example |
|---|---|---|
response_format | The 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_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… | - |
Configuration Choices
Section titled “Configuration Choices”This resource includes mutually exclusive configuration options:
scope_choice
Section titled “scope_choice”| Option | Description | Recommended |
|---|---|---|
spec.bigip_virtual_server | Bigip virtual server | |
spec.cdn_loadbalancer | Cdn loadbalancer | |
spec.http_loadbalancer | Http loadbalancer |
Example Usage
Section titled “Example Usage”Ask Claude to help you work with App API Group resources:
Create App API Group
Section titled “Create App API Group”“Create a app-api-group named ‘example’ in the ‘production’ namespace”
List App API Groups
Section titled “List App API Groups”“List all app-api-groups in the ‘production’ namespace”
Get App API Group Details
Section titled “Get App API Group Details”“Get details of the app-api-group named ‘example’ in namespace ‘production‘“
CURL Examples
Section titled “CURL Examples”# List resourcescurl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/app_api_groups" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Get specific resourcecurl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/app_api_groups/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Create resourcecurl -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 resourcecurl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/app_api_groups/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"