STstatusstack

Update an incident on a custom source

Changes an incident on a custom source the API key's team owns. Every field is optional; PUT and PATCH behave identically. A status change that cannot be proved newer than the incident's resolution is refused with 422 on status. Needs the write permission.

patch/v1/incidents/{incident_id}

Request

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

Request body

titlestring
descriptionstring nullable
status'investigating' | 'identified' | 'monitoring' | 'resolved' | 'postmortem' | 'completed' | 'clear'

Any incident status except scheduled.

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

Response

Incident updated

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.