Update some of an incident's editable fields, by ID

PATCH

/v1/incidents/{id}

• Production
• Staging
• Local

Parameters

Path Parameters

id

required

integer format: int64

The ID of the incident to update

Example

123

Request Body ^required

PATCH /incidents/:id

object

assigned_to

string | null format: uuid

contained_date

string | null format: date-time

description

string | null

detected_date

string | null format: date-time

occurred_date

string | null format: date-time

parent_id

Mark this incident as linked under another incident. Some(Some(id)) sets the parent; Some(None) clears it; None leaves it untouched.

integer | null format: int64

responded_date

string | null format: date-time

severity

One of:

null

null

string

string

Allowed values: SEV-5 SEV-4 SEV-3 SEV-2 SEV-1

severity_reasoning

string | null

source

string | null

status

One of:

null

null

string

The status of an incident

string

Allowed values: New In Progress Review Closed

tags

array | null

threat_objectives

array | null

A relational struct that has a threat objective type and its relevancy to a risk.

PartialEq, Eq, and Hash are implemented manually to exclude created_date, which is metadata about when the relation was mutated — not part of the identity.

object

created_date

The time that this relation was mutated

string | null format: date-time

relevance

One of:

null

null

string

The relevancy of the threat objective to the risk. Typically a value of 1, or 2. While the relevancy is null the the database, implementations of retrieving this from postgres should ignore null values.

string

Allowed values: Moderate Substantial

threat_objective

required

The threat objective type

string

Allowed values: Sabotage Data Disclosure Extortion Customer Targeting Resource Hijacking Fraud

title

string | null

Responses

200

Incident updated

Register row for an Incident. An Incident plus the relational data shown on the incident register: risk associations, threat objectives, tags, and comment count.

object

comment_count

required

integer format: int64

incident

required

Relationship, core incident information

object

assigned_to

One of:

null

null

object

A User as returned by the API.

Profile images are not embedded — clients fetch them from GET /api/v1/{icon} when icon is Some.

object

email

required

string

first_name

required

string

icon

Relative path to the user’s avatar endpoint, e.g. "users/{id}/avatar?v={hash}". None when the user has no avatar.

string | null

id

required

string format: uuid

last_name

required

string

contained_date

string | null format: date-time

created_date

required

string format: date-time

description

required

string

detected_date

required

string format: date-time

id

required

string

Example

INC-00001

occurred_date

string | null format: date-time

opened_by

required

A User as returned by the API.

Profile images are not embedded — clients fetch them from GET /api/v1/{icon} when icon is Some.

object

email

required

string

first_name

required

string

icon

Relative path to the user’s avatar endpoint, e.g. "users/{id}/avatar?v={hash}". None when the user has no avatar.

string | null

id

required

string format: uuid

last_name

required

string

parent_id

When set, this incident is linked under the named parent incident.

string | null

Example

INC-00001

responded_date

string | null format: date-time

severity

One of:

null

null

string

string

Allowed values: SEV-5 SEV-4 SEV-3 SEV-2 SEV-1

severity_reasoning

string | null

source

required

Where the incident was reported from (e.g. “Employee Reported”). Always present.

string

status

required

The status of an incident

string

Allowed values: New In Progress Review Closed

title

required

string

updated_by

required

A User as returned by the API.

Profile images are not embedded — clients fetch them from GET /api/v1/{icon} when icon is Some.

object

email

required

string

first_name

required

string

icon

Relative path to the user’s avatar endpoint, e.g. "users/{id}/avatar?v={hash}". None when the user has no avatar.

string | null

id

required

string format: uuid

last_name

required

string

updated_date

required

string format: date-time

linked_children_count

required

Number of incidents linked under this incident (i.e. children pointing at it). An incident is itself a linked child when incident.parent_id is set.

integer format: int64

risk_associations

required

Array<string>

tags

required

Array<object>

object

content

required

string

creator_id

required

string format: uuid

id

required

string format: uuid

org_id

string | null format: uuid

threat_objectives

required

Array<object>

A relational struct that has a threat objective type and its relevancy to a risk.

PartialEq, Eq, and Hash are implemented manually to exclude created_date, which is metadata about when the relation was mutated — not part of the identity.

object

created_date

The time that this relation was mutated

string | null format: date-time

relevance

One of:

null

null

string

The relevancy of the threat objective to the risk. Typically a value of 1, or 2. While the relevancy is null the the database, implementations of retrieving this from postgres should ignore null values.

string

Allowed values: Moderate Substantial

threat_objective

required

The threat objective type

string

Allowed values: Sabotage Data Disclosure Extortion Customer Targeting Resource Hijacking Fraud

400

Validation failed (e.g. empty payload, unknown source, inactive assignee)

404

Incident not found

422

Invalid parent link (self-link, cycle, multi-layer nesting, or deleted parent)