Pool Details

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

Copy endpoint

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

Fetch a single configured pool.

Parameters

path Path Parameters

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

Responses

200 application/json

Pool Details response.

type LoadBalancingSchemasSingleResponse = type LoadBalancingApiResponseSingle = never & { result?:

LoadBalancingPool

interface LoadBalancingPool {
check_regions?: LoadBalancingCheckRegions;
created_on?: LoadBalancingTimestamp;
description?: LoadBalancingSchemasDescription;
disabled_at?: LoadBalancingSchemasDisabledAt;
enabled?: LoadBalancingEnabled;
id?: LoadBalancingSchemasIdentifier;
latitude?: LoadBalancingLatitude;
load_shedding?: LoadBalancingLoadShedding;
longitude?: LoadBalancingLongitude;
minimum_origins?: LoadBalancingMinimumOrigins;
modified_on?: LoadBalancingTimestamp;
monitor?: LoadBalancingMonitorId;
name?: LoadBalancingName;
networks?: LoadBalancingNetworks;
notification_email?: LoadBalancingNotificationEmail;
notification_filter?: LoadBalancingNotificationFilter;
origin_steering?: LoadBalancingOriginSteering;
origins?: LoadBalancingOrigins;
}

; }

Client Errors

4XX application/json

Pool Details response failure.

type LoadBalancingSchemasSingleResponse = type LoadBalancingApiResponseSingle = never & { result?:

LoadBalancingPool

; } & interface LoadBalancingApiResponseCommonFailure {
errors:

LoadBalancingMessages

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

;
messages:

LoadBalancingMessages

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

;
result: null;
success: false;
}