POST
/boards/{board_id}/incidentsCreate an incident
Creates an incident or maintenance window on a board to inform users about a service disruption or planned maintenance. Supply started_at and ended_at for an operational incident, or will_start_at and will_end_at for future maintenance. The response includes the created incident and its identifier.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
board_idstringrequired
The public identifier of the board where you are creating the incident.
Incident creation payload containing an incident object with its name, phase, and severity.
incidentobjectrequired
The incident or maintenance window to create.
201Returns the created incident object, including its identifier, name, phase, severity, board identifier, and timestamps.
dataobjectoptional
successbooleanoptional
422Returned when a monitor status is invalid.
errorsarray<string>optional
successbooleanoptional
Error handling
A 422 is returned when a monitor status is invalid. The incident object must include name, phase, and severity; phase must be investigating, identified, monitoring, resolved, in_progress, verifying, completed, or scheduled, and severity must be minor, major, or maintenance. The board_id path parameter identifies the board for the incident.