API Crawler

API Crawler provides tools for creating, listing, retrieving, updating, and deleting resources in F5 Distributed Cloud.

Tools

Tool	Description
`f5xc-api-api-api-crawler-create`	Create API Crawler.
`f5xc-api-api-api-crawler-get`	Get API crawler.
`f5xc-api-api-api-crawler-list`	List API Crawler.
`f5xc-api-api-api-crawler-update`	Update API crawler.
`f5xc-api-api-api-crawler-delete`	Delete API Crawler.

Parameters

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

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

Ask Claude to help you work with API Crawler resources:

Create API Crawler

“Create a api-crawler named ‘example’ in the ‘production’ namespace”

List API Crawlers

“List all api-crawlers in the ‘production’ namespace”

Get API Crawler Details

“Get details of the api-crawler named ‘example’ in namespace ‘production‘“

CURL Examples

# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/api_crawlers" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"

# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/api_crawlers/$${PARAM}" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"

# Create resource
curl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/api_crawlers" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d @api_crawler.json

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