Skip to content
Cloudflare API
Start here
API Reference
Load Balancers
Pools

Health

Pool Health Details
GET/accounts/{account_id}/load_balancers/pools/{pool_id}/health
Preview Pool
POST/accounts/{account_id}/load_balancers/pools/{pool_id}/preview
ModelsExpand Collapse
HealthGetResponse { pool_id, pop_health }

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

pool_id: optional string

Pool ID.

pop_health: optional { healthy, origins }

List of regions and associated health status.

healthy: optional boolean

Whether health check in region is healthy.

origins: optional array of { ip }
ip: optional { failure_reason, healthy, response_code, rtt }
failure_reason: optional string

Failure reason.

healthy: optional boolean

Origin health status.

response_code: optional number

Response code from origin health check.

rtt: optional string

Origin RTT (Round Trip Time) response.

HealthCreateResponse { pools, preview_id }
pools: optional map[string]

Monitored pool IDs mapped to their respective names.

preview_id: optional string