Skip to main content
POST
Update incident fields

Restrictions

Usage

  • At least one field must be provided. Omitted fields and empty strings keep their current values, so this endpoint cannot clear a field.
  • Values equal to the current ones are skipped. Each changed field adds its own timeline entry (i_r_title, i_r_desc, i_r_impact, i_r_rc, i_r_rsltn, or i_r_severity).
  • Changing title, description, or incident_severity adds that field to manual_overrides; after that, alerts merged into the incident no longer overwrite it.
  • Closed incidents can be updated as well.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Fields to update on an incident. At least one field besides incident_id must be non-empty; omitted or empty fields keep their current values.

incident_id
string
required

Incident ID (MongoDB ObjectID).

Pattern: ^[0-9a-fA-F]{24}$
title
string

New incident title.

Required string length: 3 - 200
description
string

New description.

Required string length: 3 - 6144
impact
string

New impact description.

Required string length: 3 - 6144
root_cause
string

New root cause analysis.

Required string length: 3 - 6144
resolution
string

New resolution notes.

Required string length: 3 - 6144
incident_severity
enum<string>

New severity: Info, Warning or Critical (most severe).

Available options:
Info,
Warning,
Critical

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

No payload. Depending on the operation, data is {} or omitted from the envelope; rely only on the HTTP 200 status and the absence of error.