Virtual Host

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

Tools

Tool	Description
`f5xc-api-virtual-virtual-host-create`	Create Virtual Host.
`f5xc-api-virtual-virtual-host-get`	Get Virtual Host.
`f5xc-api-virtual-virtual-host-list`	List Virtual Host.
`f5xc-api-virtual-virtual-host-update`	Update Virtual Host.
`f5xc-api-virtual-virtual-host-delete`	Delete Virtual Host.

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:

authentication_choice

Option	Description	Recommended
`spec.authentication`	Authentication
`spec.no_authentication`	No authentication

challenge_type

Option	Description	Recommended
`spec.captcha_challenge`	Captcha challenge
`spec.js_challenge`	Js challenge
`spec.no_challenge`	No challenge

default_lb_choice

Option	Description	Recommended
`spec.default_loadbalancer`	Default loadbalancer
`spec.non_default_loadbalancer`	Non default loadbalancer

path_normalize_choice

Option	Description	Recommended
`spec.disable_path_normalize`	Disable path normalize
`spec.enable_path_normalize`	Enable path normalize

server_header_choice

Option	Description	Recommended
`spec.append_server_name`	Append server name
`spec.default_header`	Default header
`spec.pass_through`	Pass through
`spec.server_name`	Server name

tls_certificates_choice

Option	Description	Recommended
`spec.tls_cert_params`	Tls cert params
`spec.tls_parameters`	Tls parameters

Example Usage

Ask Claude to help you work with Virtual Host resources:

Create Virtual Host

“Create a virtual-host named ‘example’ in the ‘production’ namespace”

List Virtual Hosts

“List all virtual-hosts in the ‘production’ namespace”

Get Virtual Host Details

“Get details of the virtual-host named ‘example’ in namespace ‘production‘“

CURL Examples

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

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

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

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