Alerts
An alert opens when a workflow's Create Alert step runs. See Alerts and clips for how triage works in the dashboard.
Statuses
Alert status is one of:
| Status | Meaning |
|---|---|
open | New, nobody has handled it. |
acknowledged | Someone is looking at it. |
resolved | Handled, with a resolution note. |
dismissed | Closed as noise or a false alarm. |
The allowed moves are:
open→acknowledged,resolvedordismissed.acknowledged→resolvedordismissed.acknowledged,resolvedordismissed→open, with reopen.
A closed alert (resolved or dismissed) changes only through reopen. You can assign open and acknowledged alerts. A single action on an alert whose status doesn't allow it returns 409. A bulk action updates the alerts it can and lists the others under skipped.
Every action is recorded in the alert's history and in the audit log. The person who acts is always the signed-in user. An actor field in the body is accepted for older clients and ignored.
Every endpoint on this page works for operators and admins.
List alerts
/alertsLists alerts, newest first. The X-Total-Count response header gives the number of matching alerts before limit and offset are applied.
Query parameters
statusstringoptionalopen, acknowledged, resolved or dismissed. closed means resolved and dismissed. Separate several with commas, for example open,acknowledged.assigned_tostringoptionalme for alerts assigned to you, unassigned for alerts nobody has, a user ID, or an exact assignee value.camera_idintegeroptionalcamerastringoptionallimitintegeroptional1 to 500. Defaults to 50.offsetintegeroptional0.Response fields
An array of alerts:
idintegeroptionalstatusstringoptionalopen, acknowledged, resolved or dismissed.tsstringoptionalrule_namestring or nulloptionalcamera_idintegeroptionalcamera_namestringoptionalseveritystringoptionalLOW, MEDIUM, HIGH or CRITICAL.event_idintegeroptionalGET /clips/{event_id}.clip_uristring or nulloptionalnull while there is no clip.clip_urlstringoptional/clips/134299. Only present when there is a clip.captionstring or nulloptionalcaption_statusstringoptionalcaption_generated_atstring or nulloptionalassigned_tostring or nulloptionalacknowledged_bystring or nulloptionalresolution_notesstring or nulloptionalresolved_atstring or nulloptionalResponses
status value is not valid, or assigned_to is a user ID that doesn't exist.Get an alert's history
/alerts/{alert_id}/historyLists every triage action on one alert, oldest first. Notes from earlier resolutions stay here after the alert is reopened.
Path parameters
alert_idintegerrequiredResponse fields
An array of entries:
idintegeroptionalalert_idintegeroptionalactionstringoptionalassigned, acknowledged, resolved, dismissed or reopened.actorstring or nulloptionalnotestring or nulloptionalassigned, the new assignee.tsstringoptionalResponses
Assign an alert
/alerts/{alert_id}/assignSets who the alert is assigned to. The status doesn't change. Works on open and acknowledged alerts.
Path parameters
alert_idintegerrequiredBody
assigned_tostringrequiredResponse fields
The updated alert: id, event_id, rule_id, status, assigned_to, resolution_notes, resolved_at, acknowledged_by and ts.
Responses
Acknowledge an alert
/alerts/{alert_id}/acknowledgeSets the status of an open alert to acknowledged and stores you in acknowledged_by.
Path parameters
alert_idintegerrequiredBody
notestringoptionalResponses
open.Resolve an alert
/alerts/{alert_id}/resolveSets the status to resolved, records the time and saves your note. Works on open and acknowledged alerts. A resolved alert no longer protects its event and clip from retention.
Path parameters
alert_idintegerrequiredBody
notestringrequiredresolution_notes.Responses
note is missing.Dismiss an alert
/alerts/{alert_id}/dismissSets the status to dismissed, for a false alarm or noise. Works on open and acknowledged alerts. Like a resolved alert, a dismissed alert no longer protects its event and clip from retention.
Path parameters
alert_idintegerrequiredBody
notestringoptionalresolution_notes.Responses
Reopen an alert
/alerts/{alert_id}/reopenMoves an acknowledged, resolved or dismissed alert back to open. It clears resolved_at, resolution_notes and acknowledged_by on the alert. The earlier notes stay in its history.
Path parameters
alert_idintegerrequiredBody
Optional.
notestringoptionalResponses
Bulk actions
These endpoints apply one action to several alerts at once:
| Endpoint | Body | Applies to |
|---|---|---|
POST /alerts/bulk-acknowledge | alert_ids | open alerts |
POST /alerts/bulk-resolve | alert_ids, note (required) | open and acknowledged alerts |
POST /alerts/bulk-dismiss | alert_ids, note (optional) | open and acknowledged alerts |
POST /alerts/bulk-assign | alert_ids, assigned_to (required) | open and acknowledged alerts |
If any ID doesn't exist, the request fails with 422 and nothing changes. Alerts whose status doesn't allow the action are left as they are and listed under skipped.
/alerts/bulk-resolveBody
alert_idsarray of integersrequirednotestringoptionalassigned_tostringoptionalResponse fields
updatedintegeroptionalalert_idsarray of integersoptionalskippedarray of objectsoptionalid and its current status.skipped_idsarray of integersoptional