Create a maintenance window
create_maintenance_windowSchedule one-time or recurring maintenance windows to silence alerts for selected monitors or an entire organization during deploys and planned downtime.
Instructions
Create a one-time or recurring maintenance window that silences alerts for some or all monitors. While a window is in effect its monitors keep being checked, but no incident opens and no alert goes out. Use it around a deploy or reboot instead of pause_monitor; it does not cover heartbeats (use pause_heartbeat). For a recurring schedule run preview_maintenance_window first. Requires a key with the write scope. The plan caps how many windows exist (403 past it or when the plan has none; see max_maintenance_windows in get_plan_usage). An invalid argument or schedule is a 422 naming it. Returns the window. Example: {"name": "Deploy", "scope": "MONITOR", "monitor_ids": [""], "dtstart": "2026-10-14T22:00:00", "duration_minutes": 30}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Display name, 1 to 255 characters. | |
| rrule | No | Repeats the window: one iCal RRULE without the RRULE: prefix, at most 1024 characters, for example FREQ=WEEKLY;BYDAY=SU;BYHOUR=3. Hourly, minutely and secondly frequencies are refused. Omit it for a one-time window. | |
| scope | Yes | ORG covers every monitor of the organization and ignores monitor_ids; MONITOR covers only monitor_ids. | |
| dtstart | Yes | The first start, an ISO 8601 date-time in the wall-clock time of timezone, for example 2026-10-14T22:00:00. A UTC offset or Z is a 422. | |
| enabled | No | Default true; false stores the window without effect. | |
| timezone | No | IANA zone name such as Europe/Berlin, at most 64 characters. The schedule repeats in it, so a weekly 03:00 stays 03:00 across daylight-saving changes. Defaults to the organization's timezone. | |
| monitor_ids | No | Monitor uuids from list_monitors, at least one when scope is MONITOR. An id that is not a monitor of this organization is a 404. | |
| duration_minutes | Yes | How long each occurrence lasts, 1 to 40320 minutes. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| name | Yes | ||
| rrule | Yes | ||
| scope | Yes | Known values: MONITOR, ORG. | |
| dtstart | Yes | ||
| enabled | Yes | ||
| timezone | Yes | ||
| created_at | Yes | ||
| monitor_ids | No | ||
| duration_minutes | Yes |