CHchecklyhq
Incident Updates

Create an incident update

Changed on

Creates a new update for an incident.

post/v1/incidents/{incidentId}/updates

Request

Path parameters

incidentIdstring required

Headers

x-checkly-accountstring

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

Request body

status'INVESTIGATING' | 'IDENTIFIED' | 'MONITORING' | 'RESOLVED' | 'MAINTENANCE' required

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

descriptionstring required

A description about the status update.

Example request

{
  "status": "INVESTIGATING",
  "description": "We found the issue and we are working on it."
}

Response

Created

status'INVESTIGATING' | 'IDENTIFIED' | 'MONITORING' | 'RESOLVED' | 'MAINTENANCE' required

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

descriptionstring required

A description about the status update.

idstring required

The incident update universal and unique identificator.

created_atstring date-time required

The timestamp when the incident update was created.

updated_atstring date-time nullable
incidentIdstring required

Example response

{
  "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"
}

Changes

  • bc90d1bfa738Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 87d29dc7b4feRevision changes
    • breaking

      removed the success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status