Cluster

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

Tools

Tool	Description
`f5xc-api-virtual-cluster-create`	Create Cluster.
`f5xc-api-virtual-cluster-get`	Get Cluster.
`f5xc-api-virtual-cluster-list`	List Cluster.
`f5xc-api-virtual-cluster-update`	Update Cluster.
`f5xc-api-virtual-cluster-delete`	Delete Cluster.

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…	`-`

Configuration Choices

This resource includes mutually exclusive configuration options:

http_protocol_type

Option	Description	Recommended
`spec.auto_http_config`	Auto http config
`spec.http1_config`	Http1 config
`spec.http2_options`	Http2 options

panic_threshold_type

Option	Description	Recommended
`spec.no_panic_threshold`	No panic threshold
`spec.panic_threshold`	Panic threshold

proxy_protocol_type

Option	Description	Recommended
`spec.disable_proxy_protocol`	Disable proxy protocol
`spec.proxy_protocol_v1`	Proxy protocol v1
`spec.proxy_protocol_v2`	Proxy protocol v2

Example Usage

Ask Claude to help you work with Cluster resources:

Create Cluster

“Create a cluster named ‘example’ in the ‘production’ namespace”

List Clusters

“List all clusters in the ‘production’ namespace”

Get Cluster Details

“Get details of the cluster named ‘example’ in namespace ‘production‘“

CURL Examples

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

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

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

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