Update some of an incident's editable fields, by ID
PATCH /v1/incidents/{id}
PATCH
/v1/incidents/{id}
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
integer format: int64
The ID of the incident to update
Example
123Request Body required
Section titled “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
responded_date
string | null format: date-time
severity_reasoning
string | null
source
string | null
tags
array | null
threat_objectives
array | null
A relational struct that has a threat objective type and its relevancy to a risk.
object
created_date
The time that this relation was mutated
string | null format: date-time
relevance
threat_objective
required
The threat objective type
string
title
string | null
Responses
Section titled “ Responses ”Incident updated
Core incident information for a view
object
comment_count
required
integer format: int64
incident
required
Relationship, core incident information
object
assigned_to
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
responded_date
string | null format: date-time
severity_reasoning
string | null
source
string | null
status
required
The status of an incident
string
title
required
string
updated_date
required
string format: date-time
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.
object
created_date
The time that this relation was mutated
string | null format: date-time
relevance
threat_objective
required
The threat objective type
string
Incident not found