Load Balancers
Monitor Groups
Monitor Groups endpoint reference.
List
List configured load balancer monitor groups for an account.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account Identifier. |
php
$response = $client->loadBalancers()->monitorGroups()->list('ACCOUNT_ID');
Create
Create a new load balancer monitor group for an account.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account Identifier. | |
values | array | Yes | Values to set on the monitor group, e.g. `description`, `members`. |
php
$response = $client->loadBalancers()->monitorGroups()->create('ACCOUNT_ID', []);
Get
Get a single configured load balancer monitor group for an account.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account Identifier. | |
monitorGroupId | string | Yes | Monitor Group Identifier. |
php
$response = $client->loadBalancers()->monitorGroups()->get('ACCOUNT_ID', 'MONITOR_GROUP_ID');
Edit
Apply changes to an existing monitor group, overwriting only the supplied properties.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account Identifier. | |
monitorGroupId | string | Yes | Monitor Group Identifier. | |
values | array | Yes | Values to patch on the monitor group. |
php
$response = $client->loadBalancers()->monitorGroups()->edit('ACCOUNT_ID', 'MONITOR_GROUP_ID', []);
Update
Update an existing load balancer monitor group for an account, overwriting the full configuration.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account Identifier. | |
monitorGroupId | string | Yes | Monitor Group Identifier. | |
values | array | Yes | Values to set on the monitor group, e.g. `description`, `members`. |
php
$response = $client->loadBalancers()->monitorGroups()->update('ACCOUNT_ID', 'MONITOR_GROUP_ID', []);
Delete
Delete a load balancer monitor group for an account.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account Identifier. | |
monitorGroupId | string | Yes | Monitor Group Identifier. |
php
$response = $client->loadBalancers()->monitorGroups()->delete('ACCOUNT_ID', 'MONITOR_GROUP_ID');
References
List the pools that reference a given monitor group.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | Account Identifier. | |
monitorGroupId | string | Yes | Monitor Group Identifier. |
php
$response = $client->loadBalancers()->monitorGroups()->references('ACCOUNT_ID', 'MONITOR_GROUP_ID');

