OPopenstatus
incident

Update an incident

Changed on

Acknowledge or resolve an incident

put/incident/{id}

Request

  • Base URL
    https://api.openstatus.dev (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header x-openstatus-key

Path parameters

idstring required

The id of the Incident

Example:1

Request body

acknowledgedAtstring date-time nullable

The date the incident was acknowledged

resolvedAtstring date-time nullable

The date the incident was resolved

Response

Update a monitor

idnumber required

The id of the incident

startedAtstring date-time nullable required

The date the incident started

monitorIdnumber nullable required

The id of the monitor associated with the incident

acknowledgedAtstring date-time nullable

The date the incident was acknowledged

acknowledgedBynumber nullable required

The user who acknowledged the incident

resolvedAtstring date-time nullable

The date the incident was resolved

resolvedBynumber nullable required

The user who resolved the incident

Example response

{
  "id": 1,
  "monitorId": 1
}

Changes

  • a3ef7e6cc6acRevision changes
    • breaking

      the response's property format changed from date to date-time for status

    • breaking

      the response's property format changed from date to date-time for status

    • breaking

      the response's property format changed from date to date-time for status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • info

      the request property format was generalized from date to date-time

    • info

      the request property format was generalized from date to date-time

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status