create_maintenance_window
Schedule a maintenance window to suppress alerts during planned deployments or maintenance. Prevents on-call paging for expected failures.
Instructions
Schedule a maintenance window to suppress alerts during planned work.
Call this BEFORE running an operation that may legitimately
cause monitors to fail — a deploy, a database migration, a
third-party service's announced downtime — so the on-call
rotation isn't paged for known-expected failures. Always
pair every successful create with a follow-up
cancel_maintenance_window once the operation finishes;
if the operation runs long, call update_maintenance_window
to push the end time back rather than letting the window
lapse early.
Time fields use ISO 8601 / RFC 3339 timestamps with explicit
timezone — UTC strongly preferred. Example:
"2026-05-15T14:00:00Z". Naive timestamps (no timezone)
are rejected by the API.
Body fields:
startsAt(required): when the window opens.endsAt(required): when the window closes; must be strictly afterstartsAt.monitorId(optional): UUID of a single monitor to scope the window to. Omit (or set null) to make this an org-wide window that suppresses alerts on every monitor in the workspace — the right choice for a deploy or migration that touches the whole platform.reason(optional): human-readable explanation ("v0.7.3 deploy", "Postgres major upgrade"). Surfaces in the dashboard and on-call channel; keep it specific.repeatRule(optional): iCal RRULE string for recurring windows (max 100 chars), e.g.FREQ=WEEKLY;BYDAY=SUfor weekly Sunday maintenance. Omit for one-time windows.suppressAlerts(optional): whether the window actually silences alerts. Defaulttrue; setfalseto record a maintenance window for audit without changing alerting behavior.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |