Skip to main content
POST
Create

Authorizations

Authorization
string
header
required

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

Body

application/json
message
string
required

Markdown update on what's changed about this status page maintenance window

Maximum string length: 4096
Example:

"Scheduled maintenance is underway for our database infrastructure. Some services may experience brief interruptions during this window."

notify_subscribers
boolean
required

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

Example:

true

status_page_maintenance_id
string
required

ID of the status page maintenance window

Example:

"01FCNDV6P870EA6S7TK1DSYDG1"

component_statuses
object[]

An array of mappings from component ID to component status. This must not be set if the status page maintenance window status is being set to "maintenance_complete", as all components statuses will update to "operational".

Example:
maintenance_status
enum<string>

Optional new status for this status page maintenance window. If not provided, the status will remain unchanged. Setting to "maintenance_complete" will end the maintenance window and all component statuses will update to "operational".

Available options:
maintenance_scheduled,
maintenance_in_progress,
maintenance_complete
Example:

"maintenance_scheduled"

Response

201 - application/json

Created response.

status_page_maintenance_update
object