Skip to main content
PUT
/
v1
/
incidents
/
{incidentId}
/
updates
/
{id}
Update an incident update
curl --request PUT \
  --url https://api.checklyhq.com/v1/incidents/{incidentId}/updates/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "We found the issue and we are working on it."
}'
{
  "status": "INVESTIGATING",
  "description": "We found the issue and we are working on it.",
  "id": "e50ad839-1b90-4955-b716-1c6edbda57cb",
  "created_at": "2022-09-08T19:41:28.658Z",
  "updated_at": "2022-09-08T20:41:28.658Z"
}

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
​
incidentId
string
required

Body

application/json
​
description
string
required

A description about the status update.

Example:

"We found the issue and we are working on it."

Response

Successful

​
status
enum<string>
required

The incident update status. Must be one of INVESTIGATING,IDENTIFIED,MONITORING,RESOLVED,MAINTENANCE

Available options:
INVESTIGATING,
IDENTIFIED,
MONITORING,
RESOLVED,
MAINTENANCE
Example:

"INVESTIGATING"

​
description
string
required

A description about the status update.

Example:

"We found the issue and we are working on it."

​
id
string
required

The incident update universal and unique identificator.

Example:

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

​
created_at
string<date>
required

The timestamp when the incident update was created.

Example:

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

​
updated_at
string<date>
required

The timestamp when last the update.

Example:

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

⌘I