Load Balancers

Pools

Pools endpoint reference.

List

List configured load balancer pools for an account.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account Identifier.

php

$response = $client->loadBalancers()->pools()->list('ACCOUNT_ID');

View this operation on the Cloudflare API Reference

Create

Create a new load balancer pool for an account.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account Identifier.
`values`	`array`	Yes		Values to set on the pool, e.g. `name`, `origins`.

php

$response = $client->loadBalancers()->pools()->create('ACCOUNT_ID', []);

View this operation on the Cloudflare API Reference

Get

Get a single configured load balancer pool for an account.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account Identifier.
`poolId`	`string`	Yes		Pool Identifier.

php

$response = $client->loadBalancers()->pools()->get('ACCOUNT_ID', 'POOL_ID');

View this operation on the Cloudflare API Reference

Update

Update an existing load balancer pool for an account, overwriting the full configuration.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account Identifier.
`poolId`	`string`	Yes		Pool Identifier.
`values`	`array`	Yes		Values to set on the pool, e.g. `name`, `origins`.

php

$response = $client->loadBalancers()->pools()->update('ACCOUNT_ID', 'POOL_ID', []);

View this operation on the Cloudflare API Reference

Edit

Apply changes to an existing pool, overwriting only the supplied properties.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account Identifier.
`poolId`	`string`	Yes		Pool Identifier.
`values`	`array`	Yes		Values to patch on the pool.

php

$response = $client->loadBalancers()->pools()->edit('ACCOUNT_ID', 'POOL_ID', []);

View this operation on the Cloudflare API Reference

Bulk Edit

Apply changes to a number of existing pools, overwriting the supplied properties. Returns the list of affected pools.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account Identifier.
`values`	`array`	Yes		List of pool patches to apply, each identified by `id`.

php

$response = $client->loadBalancers()->pools()->bulkEdit('ACCOUNT_ID', []);

View this operation on the Cloudflare API Reference

Delete

Delete a load balancer pool for an account.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account Identifier.
`poolId`	`string`	Yes		Pool Identifier.

php

$response = $client->loadBalancers()->pools()->delete('ACCOUNT_ID', 'POOL_ID');

View this operation on the Cloudflare API Reference

Health

Fetch the latest pool health status for a single pool.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account Identifier.
`poolId`	`string`	Yes		Pool Identifier.

php

$response = $client->loadBalancers()->pools()->health('ACCOUNT_ID', 'POOL_ID');

View this operation on the Cloudflare API Reference

Preview

Preview pool health using the specified monitor and show the effective response.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account Identifier.
`poolId`	`string`	Yes		Pool Identifier.
`values`	`array`	No	`[]`	The monitor details to run the preview with.

php

$response = $client->loadBalancers()->pools()->preview('ACCOUNT_ID', 'POOL_ID', []);

View this operation on the Cloudflare API Reference

References

List the load balancers that reference a given pool.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account Identifier.
`poolId`	`string`	Yes		Pool Identifier.

php

$response = $client->loadBalancers()->pools()->references('ACCOUNT_ID', 'POOL_ID');

View this operation on the Cloudflare API Reference

Edit this pageorReport an issue

Load Balancers

Load balancers distribute traffic across your origin servers to reduce response time and increase availability. A load balancer is scoped to either an account or a zone: pass exactly one of $accountId or $zoneId.

Monitors

Monitors endpoint reference.