POST/v3/incidents

Create an incident

Creates a new incident.

Request

Bodyapplication/json

titleobjectrequired

Localized title of the incident. Use language keys (en, fr, de, ru, nl, pl, se).

typeenum<string>required

Type of the incident

Available options:

outageincident

affectedComponentsarray<string>optional

Array of component UUIDs affected by the incident

Example:["comp_123"]

statuspagesarray<string>optional

Array of status page UUIDs the incident should be reported on

Example:["sp_123"]

updatesarray<object>optional

Array of initial updates. Each update should have date (ISO 8601), text (localized object), and type.

💡Update Types

Available update types: investigating, identified, update, monitoring, resolved

Response

Returns the UUID of the newly created incident.

RequestcURL

curl -X POST https://api.hyperping.io/v3/incidents \
  -H "Authorization: Bearer ${API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": {
      "en": "We are investigating the issue",
      "fr": "Nous enquêtons sur le problème"
    },
    "type": "outage",
    "affectedComponents": ["comp_123"],
    "statuspages": ["sp_123"],
    "updates": [
      {
        "date": "2023-10-01T13:00:00Z",
        "text": {
          "en": "We are investigating the issue",
          "fr": "Nous enquêtons sur le problème"
        },
        "type": "investigating"
      }
    ]
  }'

201 CreatedJSON

{
  "message": "Incident created successfully",
  "uuid": "inci_cDAqydvnNnyc8D"
}

← Get an incident Update an incident →