Skip to content

Origin Pool

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

ToolDescription
f5xc-api-virtual-origin-pool-createCreate Origin Pool.
f5xc-api-virtual-origin-pool-getGet Origin Pool.
f5xc-api-virtual-origin-pool-listList Origin Pool.
f5xc-api-virtual-origin-pool-updateUpdate Origin Pool.
f5xc-api-virtual-origin-pool-deleteDelete Origin Pool.
ParameterDescriptionExample
namespaceNamespace This defines the workspace within which each the configuration object is to be created.system
nameName The name of the configuration object to be fetched.example-resource
ParameterDescriptionExample
response_formatThe 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_filterA LabelSelectorType expression that every item in list response will satisfy.-
report_fieldsThe report_fields parameter…-
report_status_fieldsThe report_status_fields parameter…-

This resource includes mutually exclusive configuration options:

OptionDescriptionRecommended
spec.health_check_portHealth check port
spec.same_as_endpoint_portSame as endpoint port✅ Yes
OptionDescriptionRecommended
spec.automatic_portAutomatic port
spec.lb_portLb port
spec.portPort
OptionDescriptionRecommended
spec.no_tlsNo tls✅ Yes
spec.use_tlsUse tls

Ask Claude to help you work with Origin Pool resources:

“Create a origin-pool named ‘example’ in the ‘production’ namespace”

“List all origin-pools in the ‘production’ namespace”

“Get details of the origin-pool named ‘example’ in namespace ‘production‘“

Terminal window
# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/origin_pools" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/origin_pools/$${PARAM}" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Create resource
curl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/origin_pools" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json" \
-d @origin_pool.json
# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/origin_pools/$${PARAM}" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}"