status_report

Create a status report

Changed on
post/status_report

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

Request body

titlestring required

The title of the status report

status'investigating' | 'identified' | 'monitoring' | 'resolved' required

The current status of the report

monitorIdsnumber[]

Ids of the monitors the status report.

pageIdnumber required

The id of the page this status report belongs to

datestring date-time nullable

The date of the report in ISO8601 format, defaults to now

messagestring required

The message of the current status of incident

Example request

{
  "title": "Documenso"
}

Response

The created status report

idnumber required

The id of the status report

titlestring required

The title of the status report

status'investigating' | 'identified' | 'monitoring' | 'resolved' required

The current status of the report

statusReportUpdateIdsnumber[] nullable

The ids of the status report updates

monitorIdsnumber[]

Ids of the monitors the status report.

pageIdnumber required

The id of the page this status report belongs to

Example response

{
  "title": "Documenso"
}

Changes

    • info

      the request property default value changed from 2026-10-08T18:46:39.061Z to 2026-10-31T08:51:08.750Z

    • info

      the request property default value changed from 2026-09-10T07:58:20.617Z to 2026-10-08T18:46:39.061Z