Sign in

v1

latestOpenAPI 3.1.02026-08-06360288.3 KB
Incidents

Update Incident

Update an existing incident.

post/incident/update

Headers

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

Request body

statuspage_idstring required

ID of the status page

incident_idstring required

ID of the incident

incident_detailsstring required

Message describing this incident update

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

{
  "current_state": 200,
  "current_status": 300,
  "incident_details": "We have implemented a temporary workaround and are monitoring the situation closely. Service should be restored shortly.",
  "incident_id": "52e5ebd1e32578623900000c",
  "irc": "0",
  "message_subject": "Service Incident Update: Database Connection Issues",
  "msteams": "0",
  "notify_email": "0",
  "notify_sms": "0",
  "notify_webhook": "0",
  "slack": "0",
  "social": "0",
  "statuspage_id": "52e5e0e0893548543700000b"
}

Response

OK

resultboolean

Example response

{
  "result": true,
  "status": {
    "error": "no",
    "message": "OK"
  }
}