Skip to content

Origin Pool

High Risk Operation

This resource includes operations that may cause significant changes. Review carefully before executing.

Confirmation Required

Some operations on this resource require explicit confirmation before execution.

Shape of the origin pool create specification.

Tools

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 Replace Origin Pool.
f5xc-api-virtual-origin-pool-delete DELETE Origin Pool.

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 -

Side Effects

Operations on this resource may have the following effects:

Creates:

  • origin-pool

Modifies:

  • origin-pool

Deletes:

  • origin-pool
  • contained_resources

Example Usage

Ask Claude to help you work with Origin Pool resources:

Create Origin Pool

"Create a origin-pool named 'example' in the 'production' namespace"

List Origin Pools

"List all origin-pools in the 'production' namespace"

Get Origin Pool Details

"Get details of the origin-pool named 'example' in namespace 'production'"

CURL Examples

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