Skip to content
Cloudflare API
Start here
API Reference
Load Balancers

Pools

List Pools
load_balancers.pools.list(PoolListParams**kwargs) -> SyncSinglePage[Pool]
GET/accounts/{account_id}/load_balancers/pools
Pool Details
load_balancers.pools.get(strpool_id, PoolGetParams**kwargs) -> Pool
GET/accounts/{account_id}/load_balancers/pools/{pool_id}
Create Pool
load_balancers.pools.create(PoolCreateParams**kwargs) -> Pool
POST/accounts/{account_id}/load_balancers/pools
Update Pool
load_balancers.pools.update(strpool_id, PoolUpdateParams**kwargs) -> Pool
PUT/accounts/{account_id}/load_balancers/pools/{pool_id}
Patch Pool
load_balancers.pools.edit(strpool_id, PoolEditParams**kwargs) -> Pool
PATCH/accounts/{account_id}/load_balancers/pools/{pool_id}
Delete Pool
load_balancers.pools.delete(strpool_id, PoolDeleteParams**kwargs) -> PoolDeleteResponse
DELETE/accounts/{account_id}/load_balancers/pools/{pool_id}
Patch Pools
load_balancers.pools.bulk_edit(PoolBulkEditParams**kwargs) -> SyncSinglePage[Pool]
PATCH/accounts/{account_id}/load_balancers/pools
ModelsExpand Collapse
class Pool: …
id: Optional[str]
check_regions: Optional[List[CheckRegion]]

A list of regions from which to run health checks. Null means every Cloudflare data center.

One of the following:
"WNAM"
"ENAM"
"WEU"
"EEU"
"NSAM"
"SSAM"
"OC"
"ME"
"NAF"
"SAF"
"SAS"
"SEAS"
"NEAS"
"ALL_REGIONS"
created_on: Optional[str]
description: Optional[str]

A human-readable description of the pool.

disabled_at: Optional[datetime]

This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.

formatdate-time
enabled: Optional[bool]

Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).

latitude: Optional[float]

The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.

load_shedding: Optional[LoadShedding]

Configures load shedding policies and percentages for the pool.

longitude: Optional[float]

The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.

minimum_origins: Optional[int]

The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.

modified_on: Optional[str]
monitor: Optional[str]

The ID of the Monitor to use for checking the health of origins within this pool.

monitor_group: Optional[str]

The ID of the Monitor Group to use for checking the health of origins within this pool.

name: Optional[str]

A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.

networks: Optional[List[str]]

List of networks where Load Balancer or Pool is enabled.

notification_email: Optional[str]

This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.

notification_filter: Optional[NotificationFilter]

Filter pool and origin health notifications by resource type or health status. Use null to reset.

origin_steering: Optional[OriginSteering]

Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.

origins: Optional[List[Origin]]

The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

address: Optional[str]

The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set.

disabled_at: Optional[datetime]

This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.

formatdate-time
enabled: Optional[bool]

Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

header: Optional[Header]

The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.

name: Optional[str]

A human-identifiable name for the origin.

port: Optional[int]

The port for upstream connections. A value of 0 means the default port for the protocol will be used.

virtual_network_id: Optional[str]

The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.

weight: Optional[float]

The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.

  • origin_steering.policy="least_outstanding_requests": Use weight to scale the origin's outstanding requests.
  • origin_steering.policy="least_connections": Use weight to scale the origin's open connections.
maximum1
minimum0
multipleOf0.01
class PoolDeleteResponse: …
id: Optional[str]

PoolsHealth

Pool Health Details
load_balancers.pools.health.get(strpool_id, HealthGetParams**kwargs) -> HealthGetResponse
GET/accounts/{account_id}/load_balancers/pools/{pool_id}/health
Preview Pool
load_balancers.pools.health.create(strpool_id, HealthCreateParams**kwargs) -> HealthCreateResponse
POST/accounts/{account_id}/load_balancers/pools/{pool_id}/preview
ModelsExpand Collapse
class HealthGetResponse: …

A list of regions from which to run health checks. Null means every Cloudflare data center.

pool_id: Optional[str]

Pool ID.

pop_health: Optional[POPHealth]

List of regions and associated health status.

healthy: Optional[bool]

Whether health check in region is healthy.

origins: Optional[List[POPHealthOrigin]]
ip: Optional[POPHealthOriginIP]
failure_reason: Optional[str]

Failure reason.

healthy: Optional[bool]

Origin health status.

response_code: Optional[float]

Response code from origin health check.

rtt: Optional[str]

Origin RTT (Round Trip Time) response.

class HealthCreateResponse: …
pools: Optional[Dict[str, str]]

Monitored pool IDs mapped to their respective names.

preview_id: Optional[str]

PoolsReferences

List Pool References
load_balancers.pools.references.get(strpool_id, ReferenceGetParams**kwargs) -> SyncSinglePage[ReferenceGetResponse]
GET/accounts/{account_id}/load_balancers/pools/{pool_id}/references
ModelsExpand Collapse
class ReferenceGetResponse: …
reference_type: Optional[Literal["*", "referral", "referrer"]]
One of the following:
"*"
"referral"
"referrer"
resource_id: Optional[str]
resource_name: Optional[str]
resource_type: Optional[str]