v2

latestOpenAPI 3.0.02026-07-261859071.2 MB

Incidents

Update an incident

Updates an incident.

put/v1/incidents/{id}

Path parameters

idstring required

Query parameters

probeboolean

Headers

x-checkly-accountstring

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Request body

namestring required

A name used to describe the incident.

impact'MAINTENANCE' | 'MAJOR' | 'MINOR' required

Used to indicate the impact or severity.

startedAtstring date-time nullable

Used to indicate when incident starts to be active.

stoppedAtstring date-time nullable

Used to indicate when incident turns to inactive.

Example request

{
  "name": "Service outage",
  "impact": "MINOR",
  "startedAt": "2022-11-25T12:34:56.000Z",
  "stoppedAt": "2022-11-25T13:34:56.000Z"
}

Response

Successful

namestring required

A name used to describe the incident.

impact'MAINTENANCE' | 'MAJOR' | 'MINOR' required

Used to indicate the impact or severity.

startedAtstring date-time nullable

Used to indicate when incident starts to be active.

stoppedAtstring date-time nullable

Used to indicate when incident turns to inactive.

dashboardIdnumber required

The dashboard ID where the incident will be shown.

idstring required

The incident universal and unique identificator.

created_atstring date-time required

The timestamp when the incident was created.

updated_atstring date-time nullable required

The timestamp when the incident was last updated.

incidentUpdatesstring nullable

Example response

{
  "name": "Service outage",
  "impact": "MINOR",
  "startedAt": "2022-11-25T12:34:56.000Z",
  "stoppedAt": "2022-11-25T13:34:56.000Z",
  "dashboardId": 1234,
  "id": "e50ad839-1b90-4955-b716-1c6edbda57cb",
  "created_at": "2022-09-08T19:41:28.658Z",
  "updated_at": "2022-09-08T20:41:28.658Z"
}