Skip to main content
GET
/
v1
/
incidents
/
{id}
Retrieve an incident
curl --request GET \
  --url https://api.checklyhq.com/v1/incidents/{id} \
  --header 'Authorization: <api-key>'
{
  "name": "Service outage",
  "impact": "MINOR",
  "startedAt": "2022-11-25 12:34:56",
  "stoppedAt": "2022-11-25 13:34:56",
  "dashboardId": 1234,
  "id": "e50ad839-1b90-4955-b716-1c6edbda57cb",
  "created_at": "2022-09-08T19:41:28.658Z",
  "updated_at": "2022-09-08T20:41:28.658Z",
  "incidentUpdates": [
    {
      "id": "01f477f8-4293-4e1c-82bd-99797720434c",
      "status": "RESOLVED",
      "description": "The service is up and all is recovered.",
      "incidentId": "3abcfdfe-ae2d-4632-8dd1-18dd871e18fc",
      "created_at": "2022-09-08T20:56:48.425Z",
      "updated_at": null
    },
    {
      "id": "1f0640f8-1910-4137-b91d-ed152faa92e6",
      "status": "INVESTIGATING",
      "description": "The service is down and affects all the regions.",
      "incidentId": "3abcfdfe-ae2d-4632-8dd1-18dd871e18fc",
      "created_at": "2022-09-08T18:56:48.425Z",
      "updated_at": null
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here. Your API key is like a password: keep it secure! Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set Authorization header while using cURL: curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

​
x-checkly-account
string

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

Path Parameters

​
id
string
required

Query Parameters

​
includeAllIncidentUpdates
boolean
default:false

You use it to include all the incident updates.

Response

Successful

​
name
string
required

A name used to describe the incident.

Example:

"Service outage"

​
impact
enum<string>
default:MINOR
required

Used to indicate the impact or severity.

Available options:
MAINTENANCE,
MAJOR,
MINOR
Example:

"MINOR"

​
dashboardId
number
required

The dashboard ID where the incident will be shown.

Example:

1234

​
id
string
required

The incident universal and unique identificator.

Example:

"e50ad839-1b90-4955-b716-1c6edbda57cb"

​
created_at
string<date>
required

The timestamp when the incident was created.

Example:

"2022-09-08T19:41:28.658Z"

​
updated_at
string<date>
required

The timestamp when last the incident update.

Example:

"2022-09-08T20:41:28.658Z"

​
incidentUpdates
object[]
required

The first incident update with the status and description. It must be only one element.

Minimum length: 1
Example:
[
  {
    "id": "01f477f8-4293-4e1c-82bd-99797720434c",
    "status": "RESOLVED",
    "description": "The service is up and all is recovered.",
    "incidentId": "3abcfdfe-ae2d-4632-8dd1-18dd871e18fc",
    "created_at": "2022-09-08T20:56:48.425Z",
    "updated_at": null
  },
  {
    "id": "1f0640f8-1910-4137-b91d-ed152faa92e6",
    "status": "INVESTIGATING",
    "description": "The service is down and affects all the regions.",
    "incidentId": "3abcfdfe-ae2d-4632-8dd1-18dd871e18fc",
    "created_at": "2022-09-08T18:56:48.425Z",
    "updated_at": null
  }
]
​
startedAt
string<date-time>

Used to indicate when incident starts to be active.

Example:

"2022-11-25 12:34:56"

​
stoppedAt
string<date-time>

Used to indicate when incident turns to inactive.

Example:

"2022-11-25 13:34:56"

⌘I