Rate Limiter Policy

Shape of the Rate Limiter Policy Replace specification.

Tools

Tool	Description
`f5xc-api-virtual-rate-limiter-policy-create`	Create Specification.
`f5xc-api-virtual-rate-limiter-policy-get`	GET Specification.
`f5xc-api-virtual-rate-limiter-policy-list`	List Rate Limiter Policy.
`f5xc-api-virtual-rate-limiter-policy-update`	Replace Specification.
`f5xc-api-virtual-rate-limiter-policy-delete`	DELETE Rate Limiter Policy.

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:

server_choice

Option	Description	Recommended
`spec.any_server`	-
`spec.server_name`	-
`spec.server_name_matcher`	-
`spec.server_selector`	-

action_choice

Option	Description	Recommended
`spec.rules[].spec.apply_rate_limiter`	-
`spec.rules[].spec.bypass_rate_limiter`	-
`spec.rules[].spec.custom_rate_limiter`	-

asn_choice

Option	Description	Recommended
`spec.rules[].spec.any_asn`	-
`spec.rules[].spec.asn_list`	-
`spec.rules[].spec.asn_matcher`	-

country_choice

Option	Description	Recommended
`spec.rules[].spec.any_country`	-
`spec.rules[].spec.country_list`	-

ip_choice

Option	Description	Recommended
`spec.rules[].spec.any_ip`	-
`spec.rules[].spec.ip_matcher`	-
`spec.rules[].spec.ip_prefix_list`	-

match

Option	Description	Recommended
`spec.rules[].spec.headers[].check_not_present`	-
`spec.rules[].spec.headers[].check_present`	-
`spec.rules[].spec.headers[].item`	-

Example Usage

Ask Claude to help you work with Rate Limiter Policy resources:

Create Rate Limiter Policy

“Create a rate-limiter-policy named ‘example’ in the ‘production’ namespace”

List Rate Limiter Policys

“List all rate-limiter-policys in the ‘production’ namespace”

Get Rate Limiter Policy Details

“Get details of the rate-limiter-policy named ‘example’ in namespace ‘production‘“

CURL Examples

# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/rate_limiter_policys" \
  -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}/rate_limiter_policys/<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}/rate_limiter_policys" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d @rate_limiter_policy.json

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