Sign in

v1

latestOpenAPI 3.1.02026-08-06360288.3 KB
Incidents

Create Incident

Create a new incident.

post/incident/create

Headers

x-api-idstring required
x-api-keystring required

Request body

statuspage_idstring required

ID of the status page

all_infrastructure_affectedstring required

Apply to all components and containers. Set to 1 to affect all infrastructure, 0 to use specific infrastructure_affected list (default: 0).

infrastructure_affectedstring[] required
incident_namestring required

Descriptive title for the incident

incident_detailsstring required

Message describing this incident

current_status100 | 300 | 400 | 500 | 600 required

The status of the components and containers affected by this incident.

current_state100 | 200 | 300 | 400 required

The state of this incident.

socialstring required

Automatically post this update to Twitter/X. Set to 1 to post a message, 0 to skip.

notify_emailstring

Notify email subscribers. Set to 1 to send notification, 0 to skip.

notify_smsstring

Notify SMS subscribers. Set to 1 to send notification, 0 to skip.

notify_webhookstring

Notify webhook subscribers. Set to 1 to send notification, 0 to skip.

ircstring

Notify IRC channel. Set to 1 to send notification, 0 to skip.

msteamsstring

Notify Microsoft Teams channels. Set to 1 to send notification, 0 to skip.

slackstring

Notify Slack channels. Set to 1 to send notification, 0 to skip.

message_subjectstring

The message subject for email notifications. How to use variables in the message subject

Example request

{
  "all_infrastructure_affected": "0",
  "current_status": 300,
  "current_state": 100,
  "incident_details": "We are investigating database connection issues affecting our primary data center. Some users may experience intermittent service disruptions.",
  "incident_name": "Database Connection Issues",
  "infrastructure_affected": [
    "53d746c0383cd493cf00001a-53d746c0383cd493cf00001b",
    "53d746c0383cd493cf00001a-53d746c8383cd493cf00001e"
  ],
  "irc": "0",
  "message_subject": "Service Incident: Database Connection Issues",
  "msteams": "0",
  "notify_email": "0",
  "notify_sms": "1",
  "notify_webhook": "0",
  "slack": "0",
  "social": "0",
  "statuspage_id": "52e5e0e0893548543700000b"
}

Response

OK

resultstring

Example response

{
  "result": "52e5e0e3290548543700000b",
  "status": {
    "error": "no",
    "message": "OK"
  }
}