Skip to main content
POST
List past incidents

Restrictions

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

Parameters for the similar-past-incidents query.

incident_id
string
required

Reference incident ID (MongoDB ObjectID).

Pattern: ^[0-9a-fA-F]{24}$
limit
integer<int64> | null
default:5

Maximum number of similar incidents to return.

Required range: 0 <= x <= 100

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
required

List of similar historical incidents, ranked by relevance.