v1

latestOpenAPI 3.1.02026-08-06360288.3 KB

Incidents

Create Historic Incident

Create a historic incident.

post/incident/history/create

Headers

x-api-idstring required

x-api-keystring required

Request body

statuspage_idstring required

ID of the status page

all_infrastructure_affectedstring

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

infrastructure_affectedstring[]

incident_details_startstring required

Message describing the start of this incident

incident_namestring required

Descriptive title for the incident

incident_details_resolvestring required

Message describing the resolution of this incident

current_status100 | 300 | 400 | 500 | 600 required

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

incident_start_datestring required

Incident start date (MM/dd/yyyy)

incident_start_timestring required

Incident start time (HH:mm)

incident_end_datestring required

Incident end date (MM/dd/yyyy)

incident_end_timestring required

Incident end time (HH:mm)

Example request

{
  "all_infrastructure_affected": "0",
  "current_status": 300,
  "incident_details_resolve": "This issue has been resolved. The connection errors were caused by a failing node that was not automatically removed from the cluster. All systems are now operating normally.",
  "incident_details_start": "We are investigating API connection errors affecting our service endpoints. Some API requests may experience delays or timeouts.",
  "incident_end_date": "05/01/2015",
  "incident_end_time": "03:15",
  "incident_name": "API Service Disruption",
  "incident_start_date": "05/01/2015",
  "incident_start_time": "03:00",
  "infrastructure_affected": [
    "53d746c0383cd493cf00001a-53d746c0383cd493cf00001b",
    "53d746c0383cd493cf00001a-53d746c8383cd493cf00001e"
  ],
  "statuspage_id": "52e5e0e0893548543700000b"
}

Response

resultstring

Example response

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