Load Balancers

Pools

Load balancer pools owned by the authenticated user.

List

List the user's configured load balancer pools.

Param	Type	Required	Default	Description
`params`	`array`	No	`[]`	Query Parameters: `monitor`, to list only the pools using a given monitor.

php

$response = $client->user()->loadBalancers()->pools()->list([]);

Create

Create a new load balancer pool for the user.

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

php

$response = $client->user()->loadBalancers()->pools()->create([]);

Get

Get a single configured load balancer pool.

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

php

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

Update

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

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

php

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

Edit

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

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

php

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

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
`values`	`array`	Yes		List of pool patches to apply, each identified by `id`.

php

$response = $client->user()->loadBalancers()->pools()->bulkEdit([]);

Delete

Delete a load balancer pool.

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

php

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

Health

Fetch the latest pool health status for a single pool.

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

php

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

Preview

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

Answers with a preview identifier; read the result with $client->user()->loadBalancers()->preview().

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

php

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

References

List the load balancers that reference a given pool.

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

php

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

Edit this pageorReport an issue

Monitors

Load balancer monitors owned by the authenticated user.

Organizations

Organizations endpoint reference.