Create an incident on a custom source

Opens an incident on a custom source the API key's team owns; shared vendor sources are refused. Needs the write permission.

post/v1/incidents

Request

  • Base URL
    https://statusstack.com/api
  • Auth
    HTTP bearer

Request body

source_idstring uuid required
titlestring required
descriptionstring nullable
status'investigating' | 'identified' | 'monitoring' | 'resolved' | 'postmortem' | 'scheduled' | 'completed' | 'clear'

scheduled and completed bound a maintenance window; clear is a provider's all-clear. resolved, postmortem, completed and clear are terminal.

impact'none' | 'minor' | 'major' | 'critical' | 'maintenance'
incident_scheduled_forstring date-time nullable

Required when status is scheduled or incident_scheduled_until is given.

incident_scheduled_untilstring date-time nullable

Must be after incident_scheduled_for.

component_idsstring[]

Affected components; each must belong to the source.

Response

Incident created

idstring uuid
source_idstring uuid
titlestring
descriptionstring nullable
status'investigating' | 'identified' | 'monitoring' | 'resolved' | 'postmortem' | 'scheduled' | 'completed' | 'clear'

scheduled and completed bound a maintenance window; clear is a provider's all-clear. resolved, postmortem, completed and clear are terminal.

impact'none' | 'minor' | 'major' | 'critical' | 'maintenance'
started_atstring date-time

When the provider opened the incident.

resolved_atstring date-time nullable
scheduled_forstring date-time nullable

Start of a scheduled maintenance window; null for an unplanned incident.

scheduled_untilstring date-time nullable

End of a scheduled maintenance window; null for an unplanned incident.

urlstring uri nullable

The provider's own page for this incident.

created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.