HTTP Load Balancer

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

Tools

Tool	Description
`f5xc-api-virtual-http-loadbalancer-create`	Create HTTP Load Balancer.
`f5xc-api-virtual-http-loadbalancer-get`	Get HTTP Load Balancer.
`f5xc-api-virtual-http-loadbalancer-list`	List Configure HTTP Load Balancer.
`f5xc-api-virtual-http-loadbalancer-update`	Update HTTP Load Balancer.
`f5xc-api-virtual-http-loadbalancer-delete`	Delete Configure HTTP Load Balancer.

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:

advertise_choice

Option	Description	Recommended
`spec.advertise_custom`	Advertise custom
`spec.advertise_on_public`	Advertise on public
`spec.advertise_on_public_default_vip`	Advertise on public default vip
`spec.do_not_advertise`	Do not advertise

api_definition_choice

Option	Description	Recommended
`spec.api_specification`	Api specification
`spec.disable_api_definition`	Disable api definition

api_discovery_choice

Option	Description	Recommended
`spec.disable_api_discovery`	Disable api discovery
`spec.enable_api_discovery`	Enable api discovery

api_testing_choice

Option	Description	Recommended
`spec.api_testing`	Api testing
`spec.disable_api_testing`	Disable api testing

bot_defense_choice

Option	Description	Recommended
`spec.bot_defense`	Bot defense
`spec.bot_defense_advanced`	Bot defense advanced
`spec.disable_bot_defense`	Disable bot defense

cache_options

Option	Description	Recommended
`spec.caching_policy`	Caching policy
`spec.disable_caching`	Disable caching

challenge_type

Option	Description	Recommended
`spec.captcha_challenge`	Captcha challenge
`spec.enable_challenge`	Enable challenge
`spec.js_challenge`	Js challenge
`spec.no_challenge`	No challenge
`spec.policy_based_challenge`	Policy based challenge

client_side_defense_choice

Option	Description	Recommended
`spec.client_side_defense`	Client side defense
`spec.disable_client_side_defense`	Disable client side defense

hash_policy_choice

Option	Description	Recommended
`spec.cookie_stickiness`	Cookie stickiness
`spec.least_active`	Least active
`spec.random`	Random
`spec.ring_hash`	Ring hash
`spec.round_robin`	Round robin
`spec.source_ip_stickiness`	Source ip stickiness

ip_reputation_choice

Option	Description	Recommended
`spec.disable_ip_reputation`	Disable ip reputation
`spec.enable_ip_reputation`	Enable ip reputation

l7_ddos_auto_mitigation_action

Option	Description	Recommended
`spec.l7_ddos_action_block`	L7 ddos action block
`spec.l7_ddos_action_default`	L7 ddos action default
`spec.l7_ddos_action_js_challenge`	L7 ddos action js challenge

loadbalancer_type

Option	Description	Recommended
`spec.http`	Http
`spec.https`	Https
`spec.https_auto_cert`	Https auto cert

malicious_user_detection_choice

Option	Description	Recommended
`spec.disable_malicious_user_detection`	Disable malicious user detection
`spec.enable_malicious_user_detection`	Enable malicious user detection

malware_protection

Option	Description	Recommended
`spec.disable_malware_protection`	Disable malware protection
`spec.malware_protection_settings`	Malware protection settings

ml_config_choice

Option	Description	Recommended
`spec.multi_lb_app`	Multi lb app
`spec.single_lb_app`	Single lb app

origin_pool_choice

Option	Description	Recommended
`spec.default_pool`	Default pool
`spec.default_pool_list`	Default pool list

rate_limit_choice

Option	Description	Recommended
`spec.api_rate_limit`	Api rate limit
`spec.disable_rate_limit`	Disable rate limit
`spec.rate_limit`	Rate limit

sensitive_data_policy_choice

Option	Description	Recommended
`spec.default_sensitive_data_policy`	Default sensitive data policy
`spec.sensitive_data_policy`	Sensitive data policy

service_policy_choice

Option	Description	Recommended
`spec.active_service_policies`	Active service policies
`spec.no_service_policies`	No service policies
`spec.service_policies_from_namespace`	Service policies from namespace

slow_ddos_mitigation_choice

Option	Description	Recommended
`spec.slow_ddos_mitigation`	Slow ddos mitigation
`spec.system_default_timeouts`	System default timeouts

threat_mesh_choice

Option	Description	Recommended
`spec.disable_threat_mesh`	Disable threat mesh
`spec.enable_threat_mesh`	Enable threat mesh

trust_client_ip_headers_choice

Option	Description	Recommended
`spec.disable_trust_client_ip_headers`	Disable trust client ip headers
`spec.enable_trust_client_ip_headers`	Enable trust client ip headers

user_id_choice

Option	Description	Recommended
`spec.user_id_client_ip`	User id client ip
`spec.user_identification`	User identification

waf_choice

Option	Description	Recommended
`spec.app_firewall`	App firewall
`spec.disable_waf`	Disable waf

Example Usage

Ask Claude to help you work with HTTP Load Balancer resources:

Create HTTP Load Balancer

“Create a http-loadbalancer named ‘example’ in the ‘production’ namespace”

List HTTP Load Balancers

“List all http-loadbalancers in the ‘production’ namespace”

Get HTTP Load Balancer Details

“Get details of the http-loadbalancer named ‘example’ in namespace ‘production‘“

CURL Examples

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

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

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

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