Update Incident

POST

Updates an incident.

Request

This endpoint expects an object.
applies_to_partsobjectRequired
artifactsobjectRequired
custom_schema_specobjectRequired

Requested custom schemas described abstractly. Every provided schema’s custom field must be specified, otherwise a bad request error is returned. If a new custom schema specifier is provided, then it will be added to the work, otherwise if a custom schema is omitted from the specifier, it remains unmodified.

external_source_dataobjectRequired
idstringRequiredformat: "id"

The ID of the incident to be updated.

impactobjectRequired
owned_byobjectRequired
piaobjectRequired
playbooksobjectRequired
related_docsobjectRequired
stageobjectRequired

Update object for Stage.

staged_infoobjectRequired

Update object for StagedInfo.

sync_metadataobjectRequired
tagsobjectRequired
acknowledged_datestringOptionalformat: "date-time"

Timestamp when the incident was acknowledged.

bodystringOptionalformat: "text"

Body of the incident.

custom_fieldsobjectOptional

Application-defined custom fields.

identified_datestringOptionalformat: "date-time"

Time when the incident was identified/reported.

mitigated_datestringOptionalformat: "date-time"

Timestamp when the incident was mitigated.

reported_bylongOptional

The entity that first reported the incident.

severitylongOptional

Severity of the incident.

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.

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