Investigation
/api/v1/soc/investigationsAn analyst-led investigation, optionally rolling up alerts.
listgetcreateupdatecloseSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App 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-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| investigation_number | string | Human-readable investigation reference number. |
| title | string | Short title of the investigation. |
| description | string | Detailed description of the investigation scope. |
| status | string | Current lifecycle status of the investigation. |
| priority | string | Priority level of the investigation. |
| category | string | Category of the investigation. |
| assigned_to_id | string | ID of the analyst assigned to this investigation. |
| team_group_id | string | ID of the SOC team group that owns this investigation. |
| alert_ids | json | IDs of Alerts grouped into this investigation. |
| finding_ids | json | IDs of forensic findings associated with this investigation. |
| timeline | json | Ordered list of analyst notes and actions during the investigation. |
| sla_definition_id | string | ID of the SLA definition governing this investigation. |
| sla_tracker | json | Real-time SLA tracking data. |
| escalated_to_incident_id | string | ID of the GRC Incident this investigation was escalated to. |
| closed_at | date-time | ISO 8601 timestamp when the investigation was closed. |
| closure_reason | string | Explanation of why the investigation was closed. |
| tags | json | Free-form tags for filtering. |
API
client.soc.investigations.*Loading manifest…