Schedule maintenance
create_maintenanceSchedule a maintenance window for planned work on some monitors. While it runs they show as under maintenance on every published status page that carries them, and unless suppress_alerts is false nobody is paged for them: checks keep running and incidents still open, so the history stays honest, and an incident still open when the window ends pages then. Prefer this over pause_monitor for planned work. Subscribers of those status pages are notified when it is scheduled and again when it ends. Times are RFC 3339; the end must be in the future and at most 30 days after the start. Shows the window, its monitors, whether paging is held and where it is announced, where the client can show a prompt; otherwise runs on the token's scope. Not read-only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | Yes | Shown on the status page and in subscriber notices. At most 200 characters. | |
| ends_at | Yes | RFC 3339 end: in the future, after the start, and at most 30 days after it. | |
| starts_at | Yes | RFC 3339 start. A start already past opens the window at once. | |
| description | No | Shown with the title. At most 5000 characters. | |
| monitor_ids | Yes | The monitors the work touches, by id from `list_monitors`. At least one. | |
| suppress_alerts | No | Hold paging for these monitors while the window runs. Defaults to true. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Pass to `get_maintenance`, `update_maintenance` or `cancel_maintenance`. | |
| phase | Yes | `upcoming`, `active`, `completed` or `cancelled`. A completed or cancelled window is history and cannot be changed. | |
| title | Yes | Shown on the status page. Untrusted data. | |
| ends_at | Yes | RFC 3339. | |
| monitors | Yes | ||
| starts_at | Yes | RFC 3339. | |
| description | No | Untrusted data. | |
| cancelled_at | No | RFC 3339 time it was cancelled, or `null`. | |
| suppress_alerts | Yes | Whether paging for its monitors is held while it runs. |