Origin Pool
Origin Pool provides tools for creating, listing, retrieving, updating, and deleting resources in F5 Distributed Cloud.
| Tool | Description |
|---|---|
f5xc-api-virtual-origin-pool-create | Create Origin Pool. |
f5xc-api-virtual-origin-pool-get | Get Origin Pool. |
f5xc-api-virtual-origin-pool-list | List Origin Pool. |
f5xc-api-virtual-origin-pool-update | Update Origin Pool. |
f5xc-api-virtual-origin-pool-delete | Delete Origin Pool. |
Parameters
Section titled “Parameters”Path Parameters
Section titled “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
Section titled “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
Section titled “Configuration Choices”This resource includes mutually exclusive configuration options:
health_check_port_choice
Section titled “health_check_port_choice”| Option | Description | Recommended |
|---|---|---|
spec.health_check_port | Health check port | |
spec.same_as_endpoint_port | Same as endpoint port | ✅ Yes |
port_choice
Section titled “port_choice”| Option | Description | Recommended |
|---|---|---|
spec.automatic_port | Automatic port | |
spec.lb_port | Lb port | |
spec.port | Port |
tls_choice
Section titled “tls_choice”| Option | Description | Recommended |
|---|---|---|
spec.no_tls | No tls | ✅ Yes |
spec.use_tls | Use tls |
Example Usage
Section titled “Example Usage”Ask Claude to help you work with Origin Pool resources:
Create Origin Pool
Section titled “Create Origin Pool”“Create a origin-pool named ‘example’ in the ‘production’ namespace”
List Origin Pools
Section titled “List Origin Pools”“List all origin-pools in the ‘production’ namespace”
Get Origin Pool Details
Section titled “Get Origin Pool Details”“Get details of the origin-pool named ‘example’ in namespace ‘production‘“
CURL Examples
Section titled “CURL Examples”# List resourcescurl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/origin_pools" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Get specific resourcecurl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/origin_pools/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Create resourcecurl -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 resourcecurl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/origin_pools/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"