Skip to main content
POST
List alerts of incident

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

Filters for alerts belonging to an incident.

incident_id
string
required

Incident ID (MongoDB ObjectID).

Pattern: ^[0-9a-fA-F]{24}$
include_events
boolean

When true, include raw alert events in each alert item.

is_active
boolean | null

When true return only active alerts (Critical/Warning/Info); when false return only recovered alerts (Ok). Omit to include all.

limit
integer<int64>
default:1000

Page size, at most 1000.

Required range: 0 <= x <= 1000
p
integer<int64>
default:1

Page number starting at 1.

Required range: x >= 0

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

Paginated list of alerts merged into an incident.