Skip to main content
POST
Create
🔑 Requires the maintenance_window.create scope.

Authorizations

Authorization
string
header
required

API key from your incident.io dashboard (Settings → API keys)

Body

application/json
alert_condition_groups
object[]
required

Condition groups that determine which alerts this maintenance window applies to

Example:
end_at
string<date-time>
required

When the maintenance window should end

Example:

"2021-08-17T14:28:57.801578Z"

lead
object
required
Example:
name
string
required

Human readable name for the maintenance window

Example:

"Planned database migration"

show_in_sidebar
boolean
required

Whether to show this maintenance window in the dashboard sidebar when active

Example:

true

start_at
string<date-time>
required

When the maintenance window should start

Example:

"2021-08-17T13:28:57.801578Z"

escalation_targets
object[]

If set, alerts matching this window will be escalated to these targets

Example:
incident_id
string

If set, alerts matching this window will be automatically attached to this incident

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

notification_message
string

Custom message included in notifications about this maintenance window

Example:

"Scheduled downtime for database migration"

notify_channels
object[]

Channels to notify about the maintenance window starting and ending

Example:
notify_end_minutes_before
integer<int64>

Minutes before the end to send a notification to the configured channels

Example:

5

notify_start_minutes_before
integer<int64>

Minutes before the start to send a notification to the configured channels

Example:

15

reroute_on_end
boolean

Whether to retrigger firing alerts through alert routing when the window ends

Example:

false

resolve_on_end
boolean

Whether to automatically resolve all firing alerts that matched this window when it ends

Example:

false

Response

201 - application/json

Created response.

maintenance_window
object
required