Update Incident

POST

Updates an incident.

Request

This endpoint expects an object.
idstringRequiredformat: "id"

The ID of the incident to be updated.

acknowledged_datestringOptionalformat: "date-time"

Timestamp when the incident was acknowledged.

applies_to_partsobjectOptional
artifactsobjectOptional
bodystringOptionalformat: "text"

Body of the incident.

custom_fieldsobjectOptional

Application-defined custom fields.

custom_schema_specobjectOptional

Custom schemas described using identifiers. Each custom field in the request must have the corresponding schema specified; omission results in a Bad Request error. If a custom schema is not included in the specifier, it remains unchanged. For surfaces with human interactors, it is recommended to provide tenant_fragment: true and validate_required_fields: true.

external_source_dataobjectOptional
identified_datestringOptionalformat: "date-time"

Time when the incident was identified/reported.

impactobjectOptional
mitigated_datestringOptionalformat: "date-time"

Timestamp when the incident was mitigated.

owned_byobjectOptional
piaobjectOptional
playbooksobjectOptional
related_docsobjectOptional
reported_bylongOptional

The entity that first reported the incident.

severitylongOptional

Severity of the incident.

stageobjectOptional

Update object for Stage.

stage_validation_optionslist of enumsOptional
Allowed values: allow_invalid_transition

The type of stage validations options when updating the stage or the stage diagram of an incident.

staged_infoobjectOptional

Update object for StagedInfo.

sync_metadataobjectOptional
tagsobjectOptional
target_close_datestringOptionalformat: "date-time"

Timestamp when the incident is expected to be resolved.

titlestringOptionalformat: "text"

Title of the incident.

sourcelongOptionalDeprecated

Source of where the incident was created. Only sys users and service accounts are supposed to set this field.

Response

Success.

incidentobject
Built with