Discovery
Discovery provides tools for creating, listing, retrieving, updating, and deleting resources in F5 Distributed Cloud.
| Tool | Description |
|---|---|
f5xc-api-api-discovery-create | Create Discovery. |
f5xc-api-api-discovery-get | Get Discovery. |
f5xc-api-api-discovery-list | List Discovery. |
f5xc-api-api-discovery-update | Update Discovery. |
f5xc-api-api-discovery-delete | Delete 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… | - |
Configuration Choices
Section titled “Configuration Choices”This resource includes mutually exclusive configuration options:
cluster_identifier_choice
Section titled “cluster_identifier_choice”| Option | Description | Recommended |
|---|---|---|
spec.cluster_id | Cluster id | |
spec.no_cluster_id | No cluster id |
discovery_choice
Section titled “discovery_choice”| Option | Description | Recommended |
|---|---|---|
spec.discovery_consul | Discovery consul | |
spec.discovery_k8s | Discovery k8s |
Example Usage
Section titled “Example Usage”Ask Claude to help you work with Discovery resources:
Create Discovery
Section titled “Create Discovery”“Create a discovery named ‘example’ in the ‘production’ namespace”
List Discoverys
Section titled “List Discoverys”“List all discoverys in the ‘production’ namespace”
Get Discovery Details
Section titled “Get Discovery Details”“Get details of the 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}/discoverys" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Get specific resourcecurl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/discoverys/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Create resourcecurl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/discoverys" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}" \ -H "Content-Type: application/json" \ -d @discovery.json
# Delete resourcecurl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/discoverys/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"