Skip to main content
POST
Create

Authorizations

Authorization
string
header
required

API key from your incident.io dashboard (Settings β†’ API keys)

Body

application/json
affected_component_ids
string[]
required

An array of IDs of component affected by the maintenance window

Example:
end_at
string<date-time>
required

The time the maintenance window ends

Example:

"2025-01-28T12:00:00Z"

idempotency_key
string
required

A unique key to de-duplicate requests. If you send a request with an idempotency_key that was already used, the original response will be returned.

Example:

"maintenance-12345-abcde"

maintenance_status
enum<string>
required

Current status for this status page maintenance window

Available options:
maintenance_scheduled,
maintenance_in_progress,
maintenance_complete
Example:

"maintenance_scheduled"

message
string
required

Markdown initial update on this status page maintenance window

Maximum string length: 4096
Example:

"Planned maintenance has been scheduled to upgrade our infrastructure. We expect minimal disruption, but some features may be briefly unavailable."

name
string
required

A title for the maintenance window

Maximum string length: 200
Example:

"Routine infrastructure upgrade"

notify_subscribers
boolean
required

Whether to notify subscribers about this status page maintenance. This will not work if your status page has more than 1000 subscribers.

Example:

true

start_at
string<date-time>
required

The time the maintenance window starts

Example:

"2025-01-28T10:00:00Z"

status_page_id
string
required

ID of the status page. You can find this by calling the ListStatusPages endpoint.

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

Response

201 - application/json

Created response.

status_page_maintenance
object