Skip to main content
POST
Create

Authorizations

Authorization
string
header
required

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

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:

Response

201 - application/json

Created response.

status_page_incident
object