⌘K
OverviewAuthenticationIncidents APIGET List incidentsGET Get incidentPOST Create incidentPUT Update incidentDEL Delete incidentPOST Add update
GET/v3/incidents

Get all incidents

Returns a list of all incidents for a project.

Request

This endpoint does not require any parameters.

Response

Returns an array of incident objects.

Incident Objectapplication/json
uuidstring
Unique identifier for the incident
datestring
Incident creation date in ISO 8601 format
titleobject
Localized title object with language keys
typeenum<string>
Type of incident
Possible values:
outageincident
affectedComponentsarray<string>
Array of component UUIDs affected by the incident
statuspagesarray<string>
Array of status page UUIDs
updatesarray<object>
Array of incident updates
RequestcURL
curl https://api.hyperping.io/v3/incidents \
  -H "Authorization: Bearer ${API_TOKEN}"
200 OKJSON
[
  {
    "uuid": "inci_123",
    "date": "2023-10-01T12:00:00Z",
    "title": {
      "en": "Incident Title",
      "fr": "Titre de l'incident"
    },
    "type": "outage",
    "affectedComponents": ["comp_123"],
    "statuspages": ["sp_123"],
    "updates": [
      {
        "uuid": "update_123",
        "date": "2023-10-01T13:00:00Z",
        "text": {
          "en": "Incident update text",
          "fr": "Texte de mise à jour"
        },
        "type": "update"
      }
    ]
  }
]
← Incidents APIGet an incident →