Skip to content
Cloudflare API
Start here
API Reference
Load Balancers

Monitor Groups

List Monitor Groups
client.LoadBalancers.MonitorGroups.List(ctx, query) (*SinglePage[MonitorGroup], error)
GET/accounts/{account_id}/load_balancers/monitor_groups
Monitor Group Details
client.LoadBalancers.MonitorGroups.Get(ctx, monitorGroupID, query) (*MonitorGroup, error)
GET/accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}
Create Monitor Group
client.LoadBalancers.MonitorGroups.New(ctx, params) (*MonitorGroup, error)
POST/accounts/{account_id}/load_balancers/monitor_groups
Update Monitor Group
client.LoadBalancers.MonitorGroups.Update(ctx, monitorGroupID, params) (*MonitorGroup, error)
PUT/accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}
Patch Monitor Group
client.LoadBalancers.MonitorGroups.Edit(ctx, monitorGroupID, params) (*MonitorGroup, error)
PATCH/accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}
Delete Monitor Group
client.LoadBalancers.MonitorGroups.Delete(ctx, monitorGroupID, body) (*MonitorGroup, error)
DELETE/accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}
ModelsExpand Collapse
type MonitorGroup struct{…}
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 []MonitorGroupMember

List of monitors in this group

Enabled bool

Whether this monitor is enabled in the group

MonitorID string

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

MonitoringOnly bool

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

MustBeHealthy bool

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

CreatedAt Timeoptional

The timestamp of when the monitor was added to the group

formatdate-time
UpdatedAt Timeoptional

The timestamp of when the monitor group member was last updated

formatdate-time
CreatedAt Timeoptional

The timestamp of when the monitor group was created

formatdate-time
UpdatedAt Timeoptional

The timestamp of when the monitor group was last updated

formatdate-time