Skip to main content
POST
/
v2
/
status_page_incident_updates
CreateStatusPageIncidentUpdate
curl --request POST \
  --url https://api.incident.io/v2/status_page_incident_updates \
  --header 'Content-Type: application/json' \
  --data '
{
  "component_statuses": [
    {
      "component_id": "01FCNDV6P870EA6S7TK1DSYDG2",
      "component_status": "operational"
    }
  ],
  "incident_status": "investigating",
  "message": "The fix has been deployed and we are monitoring the situation. Some users may still experience intermittent issues.",
  "notify_subscribers": true,
  "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1"
}
'
{
  "status_page_incident_update": {
    "component_statuses": [
      {
        "component_id": "01FCNDV6P870EA6S7TK1DSYDG2",
        "component_status": "operational"
      }
    ],
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "incident_status": "investigating",
    "message": "abc123",
    "published_at": "2021-08-17T13:28:57.801578Z",
    "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1"
  }
}

Body

application/json
​
message
string
required

Markdown update on what's changed about this status page incident

Maximum string length: 4096
Example:

"The fix has been deployed and we are monitoring the situation. Some users may still experience intermittent issues."

​
notify_subscribers
boolean
required

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

Example:

true

​
status_page_incident_id
string
required

ID of the status page incident

Example:

"01FCNDV6P870EA6S7TK1DSYDG1"

​
component_statuses
object[]

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

Example:
[
  {
    "component_id": "01FCNDV6P870EA6S7TK1DSYDG2",
    "component_status": "operational"
  }
]
​
incident_status
enum<string>

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

Available options:
investigating,
identified,
monitoring,
resolved
Example:

"investigating"

Response

201 - application/json

Created response.

​
status_page_incident_update
object
Example:
{
  "component_statuses": [
    {
      "component_id": "01FCNDV6P870EA6S7TK1DSYDG2",
      "component_status": "operational"
    }
  ],
  "id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "incident_status": "investigating",
  "message": "abc123",
  "published_at": "2021-08-17T13:28:57.801578Z",
  "status_page_incident_id": "01FCNDV6P870EA6S7TK1DSYDG1"
}