Skip to main content

Maintenance Windows

Maintenance windows suppress alert notifications during planned downtime so your on-call team isn't woken up for expected outages.

Creating a maintenance window

POST /api/v1/maintenance-windows
Authorization: Bearer <token>
Content-Type: application/json

{
"name": "DB upgrade",
"description": "Migrating to PostgreSQL 16",
"start_time": "2026-03-05T02:00:00Z",
"end_time": "2026-03-05T04:00:00Z"
}
FieldTypeRequiredDescription
namestringDisplay name
start_timeRFC3339 stringStart of maintenance window
end_timeRFC3339 stringEnd of maintenance window
descriptionstringNoOptional notes
note

start_time and end_time must be valid RFC3339 timestamps (e.g. 2026-03-05T02:00:00Z).

Response (201 Created):

{
"id": "uuid",
"organization_id": "org-uuid",
"name": "DB upgrade",
"description": "Migrating to PostgreSQL 16",
"start_time": "2026-03-05T02:00:00Z",
"end_time": "2026-03-05T04:00:00Z",
"affected_services": [],
"created_by": "user-uuid",
"created_at": "2026-03-02T00:00:00Z"
}

Listing and deleting

# List active/upcoming maintenance windows
GET /api/v1/maintenance-windows

# Delete a maintenance window
DELETE /api/v1/maintenance-windows/{id}

Behavior during a window

While a maintenance window is active:

  • Checks continue running and results are stored
  • Alert rules are evaluated as usual
  • Alert notifications are suppressed — Slack messages, emails, SMS, and PagerDuty calls are held

Alerts fired during maintenance will still appear in the alerts list after the window ends, but no notifications were sent.