Pool Health Details

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

Copy endpoint

https://api.cloudflare.com/client/v4

Fetch the latest pool health status for a single pool.

Parameters

path Path Parameters

Name	Type
`pool_id` required	type LoadBalancingSchemasIdentifier = string
`account_id` required	type LoadBalancingComponentsSchemasIdentifier = string

Responses

200 application/json

Pool Health Details response.

type LoadBalancingHealthDetails = type LoadBalancingApiResponseSingle = never & { result?: { pool_id?: string;pop_health?: { healthy?: boolean;origins?:

LoadBalancingOriginHealth

interface LoadBalancingOriginHealth {
ip?: {
failure_reason?: string;
healthy?: boolean;
response_code?: number;
rtt?: string;
};
}

[]; }; }; }

Client Errors

4XX application/json

Pool Health Details response failure.

type LoadBalancingHealthDetails = type LoadBalancingApiResponseSingle = never & { result?: { pool_id?: string;pop_health?: { healthy?: boolean;origins?:

LoadBalancingOriginHealth

interface LoadBalancingOriginHealth {
ip?: {
failure_reason?: string;
healthy?: boolean;
response_code?: number;
rtt?: string;
};
}

[]; }; }; } & interface LoadBalancingApiResponseCommonFailure {
errors:

LoadBalancingMessages

type LoadBalancingMessages = { code: number;message: string; }[]

;
messages:

LoadBalancingMessages

type LoadBalancingMessages = { code: number;message: string; }[]

;
result: null;
success: false;
}