Search + K

Command Palette

Search for a command to run...

Sign In

Patch Pools

PATCH /accounts/{account_id}/load_balancers/pools
Copy endpoint
https://api.cloudflare.com/client/v4

Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending name. Returns the list of affected pools. Supports the standard pagination query parameters, either limit/offset or per_page/page.

Parameters

path Path Parameters

Name Type
account_id required
type LoadBalancingComponentsSchemasIdentifier = string

Request Body

application/json required
string

Responses

200 application/json

Patch Pools response.

type LoadBalancingSchemasResponseCollection = type LoadBalancingApiPaginatedResponseCollection = 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

Patch Pools response failure.

type LoadBalancingSchemasResponseCollection = type LoadBalancingApiPaginatedResponseCollection = 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;
}
[]
; }
& interface LoadBalancingApiResponseCommonFailure {
errors: LoadBalancingMessages
type LoadBalancingMessages = { code: number;message: string; }[]
;
messages: LoadBalancingMessages
type LoadBalancingMessages = { code: number;message: string; }[]
;
result: null;
success: false;
}