API Reference

Load Balancers

Pools

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Health

Pool Health Details

client.loadBalancers.pools.health.get(stringpoolId, HealthGetParams { account_id } params, RequestOptionsoptions?): HealthGetResponse { pool_id, pop_health }

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

Preview Pool

client.loadBalancers.pools.health.create(stringpoolId, HealthCreateParams { account_id, allow_insecure, consecutive_down, 14 more } params, RequestOptionsoptions?): HealthCreateResponse { pools, preview_id }

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?: string

Pool ID.

pop_health?: POPHealth { healthy, origins }

List of regions and associated health status.

healthy?: boolean

Whether health check in region is healthy.

origins?: Array<Origin>

ip?: IP { failure_reason, healthy, response_code, rtt }

failure_reason?: string

Failure reason.

healthy?: boolean

Origin health status.

response_code?: number

Response code from origin health check.

rtt?: string

Origin RTT (Round Trip Time) response.

HealthCreateResponse { pools, preview_id }

pools?: Record<string, string>

Monitored pool IDs mapped to their respective names.

preview_id?: string