StatusGator Octri Preview
POST/boards/{board_id}/outage_reports

Create an outage report

Creates an outage report for a monitor on a board. Include monitor_id in outage_report, and optionally provide affected component_ids, a reporter email, and a comment of up to 300 characters. A 201 response returns the created report and triggers side effects.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
board_idstringrequired
The public ID of the board for the outage report.

Outage report payload containing an outage_report object.

outage_reportobjectrequired
The outage report details, including the required `monitor_id` and any optional comment, affected component IDs, or reporter email.

5 status codes
201Returns the created outage report, including its comment, affected components, confirmation and creation timestamps, reporter email, monitor, and related details. Creating the report triggers side effects.
dataobjectoptional
successbooleanoptional
401Returned when the request is unauthorized.
errorsarray<string>optional
successbooleanoptional
403Returned when the request uses a read-only token.
errorsarray<string>optional
successbooleanoptional
404Returned when `monitor_id` is missing.
errorsarray<string>optional
successbooleanoptional
422Returned when the comment exceeds 300 characters.
errorsarray<string>optional
successbooleanoptional

Error handling

A 401 is returned when the request is unauthorized; a 403 is returned when the token is read-only; a 404 is returned when monitor_id is missing; and a 422 is returned when comment exceeds 300 characters. The outage_report object and its monitor_id field are required, and comment must not exceed 300 characters. The board_id path parameter must identify the board for the report.