API Reference

Load Balancers

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Monitor Groups

List Monitor Groups

client.loadBalancers.monitorGroups.list(MonitorGroupListParams { account_id } params, RequestOptionsoptions?): SinglePage<MonitorGroup { id, description, members, 2 more } >

GET/accounts/{account_id}/load_balancers/monitor_groups

Monitor Group Details

client.loadBalancers.monitorGroups.get(stringmonitorGroupId, MonitorGroupGetParams { account_id } params, RequestOptionsoptions?): MonitorGroup { id, description, members, 2 more }

GET/accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}

Create Monitor Group

client.loadBalancers.monitorGroups.create(MonitorGroupCreateParams { account_id, description, members } params, RequestOptionsoptions?): MonitorGroup { id, description, members, 2 more }

POST/accounts/{account_id}/load_balancers/monitor_groups

Update Monitor Group

client.loadBalancers.monitorGroups.update(stringmonitorGroupId, MonitorGroupUpdateParams { account_id, description, members } params, RequestOptionsoptions?): MonitorGroup { id, description, members, 2 more }

PUT/accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}

Patch Monitor Group

client.loadBalancers.monitorGroups.edit(stringmonitorGroupId, MonitorGroupEditParams { account_id, description, members } params, RequestOptionsoptions?): MonitorGroup { id, description, members, 2 more }

PATCH/accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}

Delete Monitor Group

client.loadBalancers.monitorGroups.delete(stringmonitorGroupId, MonitorGroupDeleteParams { account_id } params, RequestOptionsoptions?): MonitorGroup { id, description, members, 2 more }

DELETE/accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}

ModelsExpand Collapse

MonitorGroup { id, description, members, 2 more }

id: string

The ID of the Monitor Group to use for checking the health of origins within this pool.

description: string

A short description of the monitor group

members: Array<Member>

List of monitors in this group

enabled: boolean

Whether this monitor is enabled in the group

monitor_id: string

The ID of the Monitor to use for checking the health of origins within this pool.

monitoring_only: boolean

Whether this monitor is used for monitoring only (does not affect pool health)

must_be_healthy: boolean

Whether this monitor must be healthy for the pool to be considered healthy

created_at?: string

The timestamp of when the monitor was added to the group

formatdate-time

updated_at?: string

The timestamp of when the monitor group member was last updated

formatdate-time

created_on?: string

The timestamp of when the monitor group was created

formatdate-time

modified_on?: string

The timestamp of when the monitor group was last updated

formatdate-time

Monitor GroupsReferences

List Monitor Group References

client.loadBalancers.monitorGroups.references.get(stringmonitorGroupId, ReferenceGetParams { account_id } params, RequestOptionsoptions?): SinglePage<ReferenceGetResponse { reference_type, resource_id, resource_name, resource_type } >

GET/accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}/references

ModelsExpand Collapse

ReferenceGetResponse { reference_type, resource_id, resource_name, resource_type }

reference_type?: "*" | "referral" | "referrer"

One of the following:

"*"

"referral"

"referrer"

resource_id?: string

resource_name?: string

resource_type?: string