Skip to main content
POST
/
v2
/
status_page_incidents
CreateStatusPageIncident
curl --request POST \
  --url https://api.incident.io/v2/status_page_incidents \
  --header 'Content-Type: application/json' \
  --data '
{
  "component_statuses": [
    {
      "component_id": "01FCNDV6P870EA6S7TK1DSYDG2",
      "component_status": "operational"
    }
  ],
  "idempotency_key": "alert-12345-abcde",
  "incident_status": "investigating",
  "message": "We are currently investigating reports of elevated error rates affecting our API.",
  "name": "Elevated API latency",
  "notify_subscribers": true,
  "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0"
}
'
{
  "status_page_incident": {
    "component_impacts": [
      {
        "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN",
        "component_status": "degraded_performance",
        "end_at": "2021-08-17T13:28:57.801578Z",
        "start_at": "2021-08-17T13:28:57.801578Z"
      }
    ],
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "incident_status": "investigating",
    "name": "Elevated API latency",
    "published_at": "2021-08-17T13:28:57.801578Z",
    "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "updates": [
      {
        "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
​
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:

"alert-12345-abcde"

​
incident_status
enum<string>
required

Current status for this status page incident

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

"investigating"

​
message
string
required

Markdown initial update on this status page incident

Maximum string length: 4096
Example:

"We are currently investigating reports of elevated error rates affecting our API."

​
name
string
required

A title for the incident

Maximum string length: 200
Example:

"Elevated API latency"

​
notify_subscribers
boolean
required

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

Example:

true

​
status_page_id
string
required

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

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

​
component_statuses
object[]

An array of mappings from component ID to current component status

Example:
[
  {
    "component_id": "01FCNDV6P870EA6S7TK1DSYDG2",
    "component_status": "operational"
  }
]

Response

201 - application/json

Created response.

​
status_page_incident
object
Example:
{
  "component_impacts": [
    {
      "component_id": "01GW7P4ES31Q6V1ZQH321T0GJN",
      "component_status": "degraded_performance",
      "end_at": "2021-08-17T13:28:57.801578Z",
      "start_at": "2021-08-17T13:28:57.801578Z"
    }
  ],
  "id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "incident_status": "investigating",
  "name": "Elevated API latency",
  "published_at": "2021-08-17T13:28:57.801578Z",
  "status_page_id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "updates": [
    {
      "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"
    }
  ]
}