Playground

Playground

Incident

/api/v1/grc/incidents

A security or compliance incident.

listgetcreateupdate

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.
incident_numberstringHuman-readable incident reference number.
titlestringShort title of the incident.
descriptionstringDetailed description of the incident.
categorystringClassification of the incident type.
severitystringSeverity rating of the incident.
statusstringCurrent lifecycle status of the incident.
detected_atdate-timeISO 8601 timestamp when the incident was detected.
reported_atdate-timeISO 8601 timestamp when the incident was formally reported.
contained_atdate-timeISO 8601 timestamp when the incident was contained.
closed_atdate-timeISO 8601 timestamp when the incident was closed.
realized_risk_idsjsonIDs of Risk records that were realized by this incident.
affected_asset_idsjsonIDs of assets affected by this incident.
affected_account_idsjsonIDs of accounts affected by this incident.
consolidated_investigation_idsjsonIDs of SOC Investigations rolled up into this incident.
triggered_by_alert_idsjsonIDs of SOC Alerts that triggered this incident.
owner_idstringID of the Person who owns this incident.
commander_idsjsonIDs of Persons serving as incident commanders.
root_causestringRoot cause analysis summary.
lessons_learnedjsonLessons learned from this incident.
corrective_action_idsjsonIDs of follow-up tasks created as corrective actions.
reportable_tojsonIDs of regulators to whom this incident must be reported.
reported_to_regulators_atdate-timeISO 8601 timestamp when the incident was reported to regulators.
customer_notified_atdate-timeISO 8601 timestamp when affected customers were notified.
financial_impactnumberEstimated financial impact in USD.
mttd_minutesnumberMean time to detect in minutes.
mttr_minutesnumberMean time to recover in minutes.
tagsjsonFree-form tags for filtering.

API

client.grc.incidents.*
Loading manifest…