Cloudflare API | Load Balancers › Pools

Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.

Load Balancers Monitors

References

load_balancers.monitors.references

Methods

List Monitor References -> Envelope<Array<{ reference_type, resource_id, resource_name, 1 more... }>>

get/accounts/{account_id}/load_balancers/monitors/{monitor_id}/references

Get the list of resources that reference the provided monitor.

Load Balancers

Pools

load_balancers.pools

Methods

Patch Pools -> Envelope<Array<

Pool

patch/accounts/{account_id}/load_balancers/pools

Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending name. Returns the list of affected pools. Supports the standard pagination query parameters, either limit/offset or per_page/page.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Load Balancing: Monitors and Pools Write

Parameters

account_id: string

Identifier

Response fields

errors: Array<

ResponseInfo

messages: Array<

ResponseInfo

result: Array<

Pool

success: true

Whether the API call was successful

result_info: { count, page, per_page, 2 more... }

Optional

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/load_balancers/pools \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{}'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": [
    {
      "id": "17b5962d775c646f3f9725cbc7a53df4",
      "check_regions": [
        "WNAM",
        "ENAM"
      ],
      "created_on": "2014-01-01T05:20:00.12345Z",
      "description": "Primary data center - Provider XYZ",
      "disabled_at": "2019-12-27T18:11:19.117Z",
      "enabled": false,
      "latitude": 0,
      "load_shedding": {
        "default_percent": 0,
        "default_policy": "random",
        "session_percent": 0,
        "session_policy": "hash"
      },
      "longitude": 0,
      "minimum_origins": 0,
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "monitor": "monitor",
      "name": "primary-dc-1",
      "networks": [
        "string"
      ],
      "notification_email": "someone@example.com,sometwo@example.com",
      "notification_filter": {
        "origin": {
          "disable": true,
          "healthy": true
        },
        "pool": {
          "disable": true,
          "healthy": false
        }
      },
      "origin_steering": {
        "policy": "random"
      },
      "origins": [
        {
          "address": "0.0.0.0",
          "disabled_at": "2019-12-27T18:11:19.117Z",
          "enabled": true,
          "header": {
            "Host": [
              "example.com"
            ]
          },
          "name": "app-server-1",
          "virtual_network_id": "a5624d4e-044a-4ff0-b3e1-e2465353d4b4",
          "weight": 0.6
        }
      ]
    }
  ],
  "success": true,
  "result_info": {
    "count": 20,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}

Create Pool -> Envelope<

Pool

post/accounts/{account_id}/load_balancers/pools

Create a new pool.

Delete Pool -> Envelope<{ id }>

delete/accounts/{account_id}/load_balancers/pools/{pool_id}

Delete a configured pool.

Patch Pool -> Envelope<

Pool

patch/accounts/{account_id}/load_balancers/pools/{pool_id}

Apply changes to an existing pool, overwriting the supplied properties.

Pool Details -> Envelope<

Pool

get/accounts/{account_id}/load_balancers/pools/{pool_id}

Fetch a single configured pool.

List Pools -> SinglePage<

Pool

get/accounts/{account_id}/load_balancers/pools

List configured pools.

Update Pool -> Envelope<

Pool

put/accounts/{account_id}/load_balancers/pools/{pool_id}

Modify a configured pool.

Domain types

Pool = { id, check_regions, created_on, 15 more... }

Load Balancers Pools

Health

load_balancers.pools.health

Methods

Preview Pool -> Envelope<{ pools, preview_id }>

post/accounts/{account_id}/load_balancers/pools/{pool_id}/preview

Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.

Pool Health Details -> Envelope<{ pool_id, pop_health }>

get/accounts/{account_id}/load_balancers/pools/{pool_id}/health

Fetch the latest pool health status for a single pool.

Load Balancers Pools

References

load_balancers.pools.references

Methods

List Pool References -> Envelope<Array<{ reference_type, resource_id, resource_name, 1 more... }>>

get/accounts/{account_id}/load_balancers/pools/{pool_id}/references

Get the list of resources that reference the provided pool.

Load Balancers

Previews

load_balancers.previews

Methods

Preview Result -> Envelope<Record<string, { healthy, origins }>>

get/accounts/{account_id}/load_balancers/preview/{preview_id}

Get the result of a previous preview operation using the provided preview_id.

Load Balancers

Regions

load_balancers.regions

Methods

Get Region -> Envelope<unknown>

get/accounts/{account_id}/load_balancers/regions/{region_id}

Get a single region mapping.

List Regions -> Envelope<unknown>

get/accounts/{account_id}/load_balancers/regions

List all region mappings.

Load Balancers

Searches

load_balancers.searches

Methods

Search Resources -> Envelope<{ resources }>

get/accounts/{account_id}/load_balancers/search

Search for Load Balancing resources.