PUT/v3/incidents/{incident_uuid}

Update an incident

Updates the details of an existing incident by its UUID.

Request

Path Parameters

uuidstringrequired

The unique identifier of the incident to update

Example:"inci_123"

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

statuspagesarray<string>optional

Array of status page UUIDs the incident should be reported on

updatesarray<object>optional

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

Response

Returns a success message on successful update.

RequestcURL

curl -X PUT https://api.hyperping.io/v3/incidents/inci_123 \
  -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": "identified"
      }
    ]
  }'

200 OKJSON

{
  "message": "Incident updated successfully"
}

← Create an incident Delete an incident →