Load Balancers

Monitors

Monitors endpoint reference.

List

List configured load balancer monitors for an account.

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

php

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

View this operation on the Cloudflare API Reference

Create

Create a new load balancer monitor for an account.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account Identifier.
`values`	`array`	No	`[]`	Values to set on the monitor, e.g. `type`, `method`, `path`, `expected_codes`.

php

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

View this operation on the Cloudflare API Reference

Get

Get a single configured load balancer monitor for an account.

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

php

$response = $client->loadBalancers()->monitors()->get('ACCOUNT_ID', 'MONITOR_ID');

View this operation on the Cloudflare API Reference

Update

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

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account Identifier.
`monitorId`	`string`	Yes		Monitor Identifier.
`values`	`array`	Yes		Values to set on the monitor, e.g. `type`, `method`, `path`, `expected_codes`.

php

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

View this operation on the Cloudflare API Reference

Edit

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

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account Identifier.
`monitorId`	`string`	Yes		Monitor Identifier.
`values`	`array`	Yes		Values to patch on the monitor.

php

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

View this operation on the Cloudflare API Reference

Delete

Delete a load balancer monitor for an account.

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

php

$response = $client->loadBalancers()->monitors()->delete('ACCOUNT_ID', 'MONITOR_ID');

View this operation on the Cloudflare API Reference

Preview

Preview pools associated with a given monitor and show the effective response.

Param	Type	Required	Default	Description
`accountId`	`string`	Yes		Account Identifier.
`monitorId`	`string`	Yes		Monitor Identifier.
`values`	`array`	No	`[]`	The pools to run the preview on.

php

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

View this operation on the Cloudflare API Reference

References

List the load balancers and pools that reference a given monitor.

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

php

$response = $client->loadBalancers()->monitors()->references('ACCOUNT_ID', 'MONITOR_ID');

View this operation on the Cloudflare API Reference

Edit this pageorReport an issue

Pools

Pools endpoint reference.

Monitor Groups

Monitor Groups endpoint reference.