Playground

Playground

Alert

/api/v1/soc/alerts

A detection from a security tool.

listgetacknowledgeescalate

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
titlestringShort title of the alert.
descriptionstringDetailed description of the alert.
severitystringSeverity level of the alert.
statusstringCurrent lifecycle status of the alert.
verdictstringAnalyst verdict for this alert.
source_alertstringConnector id or name that raised this alert.
source_idstringConnector-side event or alert identifier.
timestampdate-timeISO 8601 timestamp when the alert event occurred.
mitre_tacticstringMITRE ATT&CK tactic ID.
mitre_techniquestringMITRE ATT&CK technique ID.
kill_chain_phasestringKill chain phase label.
hostjsonHost that generated the alert.
userjsonUser context associated with the alert.
indicatorsjsonThreat indicators (IOCs) associated with this alert.
related_alert_idsjsonIDs of correlated alerts.
related_finding_idsjsonIDs of forensic artefacts related to this alert.
assignee_idstringID of the analyst assigned to this alert.
investigation_idstringID of the Investigation this alert has been grouped into.
playbook_run_idsjsonIDs of automated playbook runs triggered by this alert.
ticket_refjsonExternal ticketing system reference.
raw_datajsonOriginal connector payload preserved for forensic purposes.
tagsjsonFree-form tags for filtering.

API

client.soc.alerts.*
Loading manifest…