API Discovery
API Discovery provides tools for creating, listing, retrieving, updating, and deleting resources in F5 Distributed Cloud.
| Tool | Description |
|---|---|
f5xc-api-api-api-discovery-create | Create API Discovery. |
f5xc-api-api-api-discovery-get | Get API Discovery. |
f5xc-api-api-api-discovery-list | List API Discovery. |
f5xc-api-api-api-discovery-update | Update API Discovery. |
f5xc-api-api-api-discovery-delete | Delete API Discovery. |
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… | - |
Example Usage
Section titled “Example Usage”Ask Claude to help you work with API Discovery resources:
Create API Discovery
Section titled “Create API Discovery”“Create a api-discovery named ‘example’ in the ‘production’ namespace”
List API Discoverys
Section titled “List API Discoverys”“List all api-discoverys in the ‘production’ namespace”
Get API Discovery Details
Section titled “Get API Discovery Details”“Get details of the api-discovery 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}/api_discoverys" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Get specific resourcecurl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/api_discoverys/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Create resourcecurl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/api_discoverys" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}" \ -H "Content-Type: application/json" \ -d @api_discovery.json
# Delete resourcecurl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/api_discoverys/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"