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

load_balancers.monitor_groups.list(MonitorGroupListParams**kwargs) -> SyncSinglePage[MonitorGroup]

GET/accounts/{account_id}/load_balancers/monitor_groups

Monitor Group Details

load_balancers.monitor_groups.get(strmonitor_group_id, MonitorGroupGetParams**kwargs) -> MonitorGroup

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

Create Monitor Group

load_balancers.monitor_groups.create(MonitorGroupCreateParams**kwargs) -> MonitorGroup

POST/accounts/{account_id}/load_balancers/monitor_groups

Update Monitor Group

load_balancers.monitor_groups.update(strmonitor_group_id, MonitorGroupUpdateParams**kwargs) -> MonitorGroup

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

Patch Monitor Group

load_balancers.monitor_groups.edit(strmonitor_group_id, MonitorGroupEditParams**kwargs) -> MonitorGroup

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

Delete Monitor Group

load_balancers.monitor_groups.delete(strmonitor_group_id, MonitorGroupDeleteParams**kwargs) -> MonitorGroup

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

ModelsExpand Collapse

class MonitorGroup: …

id: str

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

description: str

A short description of the monitor group

members: List[Member]

List of monitors in this group

enabled: bool

Whether this monitor is enabled in the group

monitor_id: str

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

monitoring_only: bool

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

must_be_healthy: bool

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

created_at: Optional[datetime]

The timestamp of when the monitor was added to the group

formatdate-time

updated_at: Optional[datetime]

The timestamp of when the monitor group member was last updated

formatdate-time

created_at: Optional[datetime]

The timestamp of when the monitor group was created

formatdate-time

updated_at: Optional[datetime]

The timestamp of when the monitor group was last updated

formatdate-time