Health Check

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

Tools

Tool	Description
`f5xc-api-virtual-healthcheck-create`	Create Health Check.
`f5xc-api-virtual-healthcheck-get`	Get Health Check.
`f5xc-api-virtual-healthcheck-list`	List Health Check.
`f5xc-api-virtual-healthcheck-update`	Update Health Check.
`f5xc-api-virtual-healthcheck-delete`	Delete Health Check.

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:

health_check

Option	Description	Recommended
`spec.http_health_check`	Http health check
`spec.tcp_health_check`	Tcp health check
`spec.udp_icmp_health_check`	Udp icmp health check

Example Usage

Ask Claude to help you work with Health Check resources:

Create Health Check

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

List Health Checks

“List all healthchecks in the ‘production’ namespace”

Get Health Check Details

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

CURL Examples

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

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

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

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