f5xc-api

name: f5xc-api description: "F5 Distributed Cloud REST API operations — authenticate, list, create, read, update, delete F5 XC resources (load balancers, origin pools, WAF, DNS, sites, namespaces, app firewall, bot defense, service policies). Activate when user mentions F5 XC, Distributed Cloud, volterra, XC console, API token, load balancer CRUD, origin pool, WAF policy, or platform configuration management." compatibility: opencode metadata: model: devstral-24b port: "8002" specialization: function-calling

F5 Distributed Cloud API Operations

Interact with the F5 XC platform through its REST API using curl and jq. This skill provides structured workflows for authentication, CRUD operations, and resource management across 150+ resource types.

When to use

• Listing, creating, reading, updating, or deleting F5 XC resources
• Managing HTTP/TCP/UDP load balancers and origin pools
• Configuring WAF policies, bot defense, or API security
• Managing DNS zones and DNS load balancers
• Working with cloud sites (AWS, Azure, GCP)
• Checking namespace resources or tenant configuration
• Any REST API interaction with F5 Distributed Cloud / Volterra

Environment Variables

Authentication

# All requests use the APIToken header
curl -s "${F5XC_API_URL}/api/config/namespaces/${F5XC_NAMESPACE}/http_loadbalancers" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" | jq .

CRUD Operations

List resources

curl -s "${F5XC_API_URL}/api/config/namespaces/${F5XC_NAMESPACE}/{resource_plural}" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" | jq '.items[] | {name, namespace}'

Get a specific resource

curl -s "${F5XC_API_URL}/api/config/namespaces/${F5XC_NAMESPACE}/{resource_plural}/{name}" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" | jq .

Create a resource

curl -s -X POST "${F5XC_API_URL}/api/config/namespaces/${F5XC_NAMESPACE}/{resource_plural}" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": {
      "name": "my-resource",
      "namespace": "'${F5XC_NAMESPACE}'",
      "description": "Created via API"
    },
    "spec": { ... }
  }' | jq .

Replace (update) a resource

curl -s -X PUT "${F5XC_API_URL}/api/config/namespaces/${F5XC_NAMESPACE}/{resource_plural}/{name}" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": { "name": "my-resource", "namespace": "'${F5XC_NAMESPACE}'" },
    "spec": { ... }
  }' | jq .

Delete a resource

curl -s -X DELETE "${F5XC_API_URL}/api/config/namespaces/${F5XC_NAMESPACE}/{resource_plural}/{name}" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" | jq .

Resource Quick Reference (Most Common)

For the full 150-resource index, see references/RESOURCE_INDEX.md.

Common Workflows

Create HTTP Load Balancer with Origin Pool

1. Create the origin pool:

curl -s -X POST "${F5XC_API_URL}/api/config/namespaces/${F5XC_NAMESPACE}/origin_pools" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": { "name": "my-origin", "namespace": "'${F5XC_NAMESPACE}'" },
    "spec": {
      "origin_servers": [{
        "public_name": { "dns_name": "backend.example.com" },
        "labels": {}
      }],
      "port": 443,
      "use_tls": {
        "use_host_header_as_sni": {},
        "tls_config": { "default_security": {} },
        "skip_server_verification": {}
      },
      "loadbalancer_algorithm": "LB_OVERRIDE",
      "endpoint_selection": "LOCAL_PREFERRED"
    }
  }' | jq .

2. Create the HTTP load balancer referencing the origin pool:

curl -s -X POST "${F5XC_API_URL}/api/config/namespaces/${F5XC_NAMESPACE}/http_loadbalancers" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": { "name": "my-lb", "namespace": "'${F5XC_NAMESPACE}'" },
    "spec": {
      "domains": ["app.example.com"],
      "https_auto_cert": {
        "http_redirect": true,
        "add_hsts": false,
        "port": 443,
        "no_mtls": {},
        "default_header": {},
        "enable_path_normalize": {},
        "default_loadbalancer": {}
      },
      "default_route_pools": [{
        "pool": {
          "tenant": "",
          "namespace": "'${F5XC_NAMESPACE}'",
          "name": "my-origin"
        },
        "weight": 1
      }],
      "advertise_on_public_default_vip": {},
      "disable_rate_limit": {},
      "disable_waf": {},
      "round_robin": {},
      "no_challenge": {}
    }
  }' | jq .

Error Handling