Pools
List Pools
Pool Details
Create Pool
Update Pool
Patch Pool
Delete Pool
Patch Pools
ModelsExpand Collapse
Pool = object { id, check_regions, created_on, 16 more }
This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
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).
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.
Configures load shedding policies and percentages for the pool.
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.
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.
The ID of the Monitor to use for checking the health of origins within this pool.
The ID of the Monitor Group to use for checking the health of origins within this pool.
A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
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.
Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
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.
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.
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.
This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.
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.
The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.
The port for upstream connections. A value of 0 means the default port for the protocol will be used.
The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.
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.