Skip to main content
POST
Get incident detail

Restrictions

Usage

  • num is not unique; when several incidents share it, the most recent one is returned. Prefer incident_id.
  • This endpoint does not fill alerts or the account_* fields. Use POST /incident/alert/list for alerts and POST /incident/feed for the timeline.
  • Image tokens starting with img_ in images are replaced with download URLs.
  • An unknown incident returns InvalidParameter.

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

Lookup parameters for a single incident. Supply either incident_id or num.

incident_id
string

Incident ID (MongoDB ObjectID).

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

Short incident ID (the 6-character uppercased id shown in the UI). Not unique — resolves to the most recent match. Supply either incident_id or num.

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

Detailed incident record.