Virtual Host

Replace a given virtual host in a given namespace.

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`	Replace Virtual Host.
`f5xc-api-virtual-virtual-host-delete`	DELETE Virtual Host.

Parameters

Path Parameters

Parameter	Description	Example
`metadata.namespace`	Namespace	`-`
`name`	Name	`-`
`namespace`	Namespace	`-`
`metadata.name`	Name	`-`

Query Parameters

Parameter	Description	Example
`response_format`	The format in which the configuration object is to be fetched. This could be for example	`-`
`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`	-
`spec.no_authentication`	-

challenge_type

Option	Description	Recommended
`spec.captcha_challenge`	-
`spec.js_challenge`	-
`spec.no_challenge`	-

default_lb_choice

Option	Description	Recommended
`spec.default_loadbalancer`	-
`spec.non_default_loadbalancer`	-

path_normalize_choice

Option	Description	Recommended
`spec.disable_path_normalize`	-
`spec.enable_path_normalize`	-

server_header_choice

Option	Description	Recommended
`spec.append_server_name`	-
`spec.default_header`	-
`spec.pass_through`	-
`spec.server_name`	-

strict_sni_host_header_check_choice

Option	Description	Recommended

tls_certificates_choice

Option	Description	Recommended
`spec.tls_cert_params`	-
`spec.tls_parameters`	-

cookie_params_choice

Option	Description	Recommended
`spec.authentication.cookie_params`	-
`spec.authentication.use_auth_object_config`	-

redirect_url_choice

Option	Description	Recommended
`spec.authentication.redirect_dynamic`	-
`spec.authentication.redirect_url`	-

secret_choice

Option	Description	Recommended
`spec.authentication.cookie_params.auth_hmac`	-
`spec.authentication.cookie_params.kms_key_hmac`	-

secret_info_oneof

Option	Description	Recommended
`spec.authentication.cookie_params.auth_hmac.prim_key.blindfold_secret_info`	-
`spec.authentication.cookie_params.auth_hmac.prim_key.clear_secret_info`	-

coalescing_choice

Option	Description	Recommended
`spec.coalescing_options.default_coalescing`	-
`spec.coalescing_options.strict_coalescing`	-

allowed_domains

Option	Description	Recommended
`spec.csrf_policy.all_load_balancer_domains`	-
`spec.csrf_policy.custom_domain_list`	-
`spec.csrf_policy.disabled`	-

http_protocol_choice

Option	Description	Recommended
`spec.http_protocol_options.http_protocol_enable_v1_only`	-
`spec.http_protocol_options.http_protocol_enable_v1_v2`	-
`spec.http_protocol_options.http_protocol_enable_v2_only`	-

header_transformation_choice

Option	Description	Recommended
`spec.http_protocol_options.http_protocol_enable_v1_only.header_transformation.default_header_transformation`	-
`spec.http_protocol_options.http_protocol_enable_v1_only.header_transformation.legacy_header_transformation`	-
`spec.http_protocol_options.http_protocol_enable_v1_only.header_transformation.preserve_case_header_transformation`	-
`spec.http_protocol_options.http_protocol_enable_v1_only.header_transformation.proper_case_header_transformation`	-

value_choice

Option	Description	Recommended
`spec.request_cookies_to_add[].secret_value`	-
`spec.request_cookies_to_add[].value`	-

domain_choice

Option	Description	Recommended
`spec.response_cookies_to_add[].add_domain`	-
`spec.response_cookies_to_add[].ignore_domain`	-

expiry_choice

Option	Description	Recommended
`spec.response_cookies_to_add[].add_expiry`	-
`spec.response_cookies_to_add[].ignore_expiry`	-

httponly_choice

Option	Description	Recommended
`spec.response_cookies_to_add[].add_httponly`	-
`spec.response_cookies_to_add[].ignore_httponly`	-

max_age_choice

Option	Description	Recommended
`spec.response_cookies_to_add[].ignore_max_age`	-
`spec.response_cookies_to_add[].max_age_value`	-

partitioned_choice

Option	Description	Recommended
`spec.response_cookies_to_add[].add_partitioned`	-
`spec.response_cookies_to_add[].ignore_partitioned`	-

path_choice

Option	Description	Recommended
`spec.response_cookies_to_add[].add_path`	-
`spec.response_cookies_to_add[].ignore_path`	-

samesite_choice

Option	Description	Recommended
`spec.response_cookies_to_add[].ignore_samesite`	-
`spec.response_cookies_to_add[].samesite_lax`	-
`spec.response_cookies_to_add[].samesite_none`	-
`spec.response_cookies_to_add[].samesite_strict`	-

secure_choice

Option	Description	Recommended
`spec.response_cookies_to_add[].add_secure`	-
`spec.response_cookies_to_add[].ignore_secure`	-

request_timeout_choice

Option	Description	Recommended
`spec.slow_ddos_mitigation.disable_request_timeout`	-
`spec.slow_ddos_mitigation.request_timeout`	-

client_certificate_verify_choice

Option	Description	Recommended
`spec.tls_cert_params.client_certificate_optional`	-
`spec.tls_cert_params.client_certificate_required`	-
`spec.tls_cert_params.no_client_certificate`	-

trusted_ca_choice

Option	Description	Recommended
`spec.tls_cert_params.validation_params.trusted_ca`	-
`spec.tls_cert_params.validation_params.trusted_ca_url`	-

ocsp_stapling_choice

Option	Description	Recommended
`spec.tls_parameters.common_params.tls_certificates[].custom_hash_algorithms`	-
`spec.tls_parameters.common_params.tls_certificates[].disable_ocsp_stapling`	-
`spec.tls_parameters.common_params.tls_certificates[].use_system_defaults`	-

ref_type

Option	Description	Recommended
`spec.waf_type.app_firewall`	-
`spec.waf_type.disable_waf`	-
`spec.waf_type.inherit_waf`	-

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/${NAMESPACE}/virtual_hosts" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json"

# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/virtual_hosts/<name>" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json"

# Create resource
curl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/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/${NAMESPACE}/virtual_hosts/<name>" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"