Skip to content

Maintenance Windows

A maintenance window marks a time range during which alerts from selected monitors are suppressed (not fired). Useful for planned deployments, scheduled restarts, or third-party maintenance.

MethodPathDescriptionScope
GET/api/v1/maintenance-windowsList.maintenance_windows
POST/api/v1/maintenance-windowsCreate.maintenance_windows
GET/api/v1/maintenance-windows/{id}Read.maintenance_windows
PATCH/api/v1/maintenance-windows/{id}Update.maintenance_windows
DELETE/api/v1/maintenance-windows/{id}Delete.maintenance_windows
{
"name": "DB migration 2026-05-01",
"description": "Schema migration; API gateway will serve 503s for ~5min.",
"start_at": "2026-05-01T02:00:00Z",
"end_at": "2026-05-01T03:00:00Z",
"recurrence": null,
"scope": {
"monitor_ids": ["01HX...", "01HY..."],
"group_ids": ["01HG..."],
"label_selector": { "env": "staging" }
},
"suppress_notifications": true,
"visible_on_status_pages": true
}
FieldNotes
start_at, end_atAbsolute UTC times.
recurrenceOptional { "pattern": "weekly", "days_of_week": ["tue"], "timezone": "America/Los_Angeles" }.
scope.monitor_ids / group_ids / label_selectorAny combination. Logical OR across fields; AND within a label selector.
suppress_notificationsIf false, alerts still fire but are annotated with the maintenance window.
visible_on_status_pagesIf true, status pages display the window to visitors.

GET /api/v1/public/{orgSlug}/maintenance returns upcoming windows marked visible_on_status_pages: true. No authentication required. This is the feed status-page embeds consume.