UpdateIncidentRequest data model

The UpdateIncidentRequest shape in the Visual Sentinel REST API.

Fields

Field	Type	Required	Description
`status`	string	No	RESOLVED closes the incident. One of: `INVESTIGATING`, `IDENTIFIED`, `MONITORING`, `RESOLVED`, `POSTMORTEM`.
`severity`	string	No	Case-insensitive. One of: `CRITICAL`, `HIGH`, `MEDIUM`, `LOW`, `INFO`.
`title`	string	No	Min length 1, max length 200.
`description`	string	No	Min length 1, max length 2000.
`resolution`	string	No	Max length 2000.
`rootCause`	string	No	Max length 2000.
`resolvedAt`	string (date-time)	No
`acknowledged`	boolean	No	true acknowledges the incident now, as the caller; false clears it. Repeat reminders stop while an open incident is acknowledged; the recovery still notifies.
`acknowledgedAt`	string (date-time) or null (date-time)	No	Older form of `acknowledged`: a time acknowledges at that time, null clears. Must agree with `acknowledged` when both are sent.
`autoResolve`	boolean	No	false keeps this incident open after the monitor recovers, until someone resolves it.
`notify`	boolean	No	Applies when `status` changes the incident's status. true (the default) sends the change at once to the incident's alert channels and to the subscribers of its status pages. false records it on the incident timeline without notifying anyone; the status page still shows the new status. PagerDuty, Opsgenie and Prometheus only receive a close or a reopen of an alert that a check opened. Default: `true`.
`actionId`	string (uuid)	No	A UUID you choose for a status change. Sending the request again with the same actionId changes and announces the incident only once: the repeat returns 200 and sends nothing, and may include `replayed: true`. An actionId already used on another incident returns 409.

Used by

Update incident: PUT /api/incidents/{id}
Update incident (partial): PATCH /api/incidents/{id}

Generated from the OpenAPI 3.1 specification at https://docs.visualsentinel.com/openapi.json.