Skip to main content
POST
Resolve incident

Restrictions

Usage

  • When a resolution form applies, custom_fields, summary, and images must match its visible elements and required rules.
  • For a batch, form values are accepted only when every selected incident resolves to the same form; otherwise resolve incidents individually.
  • The legacy values and custom_values properties are rejected; use custom_fields.
  • Incidents that are already closed are skipped without error; an unknown ID fails the whole call with InvalidParameter.
  • Resolving a Triggered incident first acknowledges it on behalf of the caller.
  • After closing, unfinished action items of the incident are converted to follow-ups, and later events no longer merge into the incident’s existing alerts.

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

Parameters for resolving one or more incidents.

incident_ids
string[]
required

Incident IDs to resolve. At most 100 per call.

Required array length: 1 - 100 elements
Pattern: ^[0-9a-fA-F]{24}$
root_cause
string | null

Optional root cause note applied to every resolved incident.

Maximum string length: 1024
resolution
string | null

Optional resolution note applied to every resolved incident.

Maximum string length: 1024
description
string | null

New incident description, up to 6,144 characters. When set, it replaces the current description before the incident closes.

Maximum string length: 6144
custom_fields
object

Custom field values for the resolution form. Allowed keys and values depend on the incident's visible form.

images
object[]

Images attached to the resolution timeline entry.

summary
string

Form summary recorded as a timeline comment. Accepted only when the resolution form contains a summary element.

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.