GET/v3/incidents/{incident_uuid}

Get an incident

Returns details of a specific incident by its UUID.

Request

Path Parameters

uuidstringrequired

The unique identifier of the incident

Example:"inci_123"

Response

Returns the incident object if a valid identifier was provided.

Incident Objectapplication/json

uuidstring

Unique identifier for the incident

datestring

Incident creation date in ISO 8601 format

textobject

Localized incident description text

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 with uuid, date, text, and type

RequestcURL

curl https://api.hyperping.io/v3/incidents/inci_123 \
  -H "Authorization: Bearer ${API_TOKEN}"

200 OKJSON

{
  "uuid": "inci_123",
  "date": "2023-10-01T12:00:00Z",
  "text": {
    "en": "We are investigating the issue",
    "fr": "Nous enquêtons sur le problème"
  },
  "type": "outage",
  "affectedComponents": ["comp_123"],
  "statuspages": ["sp_123"],
  "updates": [
    {
      "uuid": "update_123",
      "date": "2023-10-01T13:00:00Z",
      "text": {
        "en": "We are investigating the issue",
        "fr": "Nous enquêtons sur le problème"
      },
      "type": "update"
    }
  ]
}

← List incidents Create an incident →