Skip to main content
POST
/
v2
/
status_page_maintenance_updates
CreateStatusPageMaintenanceUpdate
curl --request POST \
  --url https://api.incident.io/v2/status_page_maintenance_updates \
  --header 'Content-Type: application/json' \
  --data '
{
  "component_statuses": [
    {
      "component_id": "01FCNDV6P870EA6S7TK1DSYDG2",
      "component_status": "operational"
    }
  ],
  "maintenance_status": "maintenance_scheduled",
  "message": "Scheduled maintenance is underway for our database infrastructure. Some services may experience brief interruptions during this window.",
  "notify_subscribers": true,
  "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1"
}
'
{
  "status_page_maintenance_update": {
    "component_statuses": [
      {
        "component_id": "01FCNDV6P870EA6S7TK1DSYDG2",
        "component_status": "operational"
      }
    ],
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "maintenance_status": "maintenance_scheduled",
    "message": "abc123",
    "published_at": "2021-08-17T13:28:57.801578Z",
    "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1"
  }
}

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:
[
  {
    "component_id": "01FCNDV6P870EA6S7TK1DSYDG2",
    "component_status": "operational"
  }
]
​
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
Example:
{
  "component_statuses": [
    {
      "component_id": "01FCNDV6P870EA6S7TK1DSYDG2",
      "component_status": "operational"
    }
  ],
  "id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "maintenance_status": "maintenance_scheduled",
  "message": "abc123",
  "published_at": "2021-08-17T13:28:57.801578Z",
  "status_page_maintenance_id": "01FCNDV6P870EA6S7TK1DSYDG1"
}