API Discovery¶

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.

Replace api_discovery replaces an existing object in the storage backend for metadata.namespace.

Tools¶

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`	Replace API Discovery.
`f5xc-api-api-api-discovery-delete`	DELETE API Discovery.

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:

api-discovery

Modifies:

api-discovery

Deletes:

api-discovery
contained_resources

Example Usage¶

Ask Claude to help you work with API Discovery resources:

Create API Discovery¶

"Create a api-discovery named 'example' in the 'production' namespace"

List API Discoverys¶

"List all api-discoverys in the 'production' namespace"

Get API Discovery Details¶

"Get details of the api-discovery named 'example' in namespace 'production'"

CURL Examples¶

# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/api_discoverys" \
  -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_discoverys/<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_discoverys" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d @api_discovery.json

# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/api_discoverys/<name>" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"