Skip to content

Monitor Groups

Monitor groups cluster related monitors for display and for group-level alerting rules (e.g. “alert only when ≥2 monitors in this group are down”).

MethodPathDescriptionScope
GET/api/v1/monitor-groupsList groups.monitors
POST/api/v1/monitor-groupsCreate.monitors
GET/api/v1/monitor-groups/{id}Read.monitors
PATCH/api/v1/monitor-groups/{id}Update.monitors
DELETE/api/v1/monitor-groups/{id}Delete.monitors

POST /api/v1/monitor-groups

{
"name": "Payment services",
"description": "Stripe, checkout, billing-webhook",
"monitor_ids": ["01HX...", "01HY..."],
"cascade": {
"alert_when_down_count_gte": 2,
"resolve_when_up_count_gte": 2
}
}
FieldRequiredNotes
nameyes
monitor_idsnoMember monitor IDs. Can be empty.
cascade.alert_when_down_count_gtenoFire a group-level alert when this many members are down.
cascade.resolve_when_up_count_gtenoAuto-resolve when this many members recover.
  • A monitor may belong to any number of groups.
  • Deleting a group does not delete its member monitors.
  • Group-level alerts are a separate alert stream from monitor-level alerts; you can route them differently.