Skip to main content
POST
List alerts

Restrictions

Usage

  • start_time and end_time are required Unix seconds and filter on the alert’s start_time; the span must not exceed 31 days.
  • With by_updated_at: true, an updated_at window with the same bounds is added on top of the start_time filter, and the span must not exceed 7 days.
  • A start_time earlier than the account’s data retention period is moved up to the retention start; an end_time before that start returns InvalidParameter.
  • Pass search_after_ctx from the previous response for the next page; without it, p/limit page numbers apply and p * limit must stay within 10,000.
  • total is capped at 1,000. has_next_page does not depend on total: it is exact in both page-number and cursor mode, also past 1,000 alerts. Every non-empty page returns search_after_ctx for its last alert; pass it back to read past the 10,000-row page-number limit.
  • Results are filtered by the caller’s channel data-access permissions.
  • Set is_active to true to retrieve only active (firing) alerts; false to retrieve resolved 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

Filter and pagination criteria for alert list queries. Time range is required.

start_time
integer<int64>
required

Start of the search window, Unix epoch seconds, applied to the alert's start_time. A value earlier than the account's data retention period is moved up to the retention start.

end_time
integer<int64>
required

End of the search window, Unix epoch seconds. Must be greater than start_time; the span must not exceed 31 days (7 days with by_updated_at). A value before the start of the data retention period returns InvalidParameter.

p
integer<int64> | null

Page number, starting at 1. Used when search_after_ctx is not provided; p * limit must stay within 10,000 records.

Required range: x >= 0
limit
integer<int64> | null

Page size. Max 100, default 20.

Required range: 0 <= x <= 100
search_after_ctx
string | null

Opaque cursor from the previous response for the next page.

is_active
boolean | null

Filter by lifecycle: true returns only firing alerts (status Critical/Warning/Info), false returns only recovered alerts (status Ok). Omit or pass null to return both.

ever_muted
boolean | null

Filter by whether the alert has ever been silenced.

alert_severity
string

Comma-separated filter on alert_severity, e.g. Critical,Warning. Allowed values: Critical, Warning, Info, Ok; other values return InvalidParameter. Ok matches nothing because alert_severity is never Ok.

channel_ids
integer<int64>[]

Filter by channel IDs.

integration_ids
integer<int64>[]

Filter by integration IDs.

alert_ids
string[]

Filter to specific alert IDs (ObjectID hex strings). Invalid IDs are ignored; if none are valid, the result is empty. At most 100 items per request; split larger sets into several calls.

Maximum array length: 100
alert_keys
string[]

Filter by alert deduplication keys. At most 100 items per request; split larger sets into several calls.

Maximum array length: 100
asc
boolean

Sort ascending by start_time when true; default is descending.

by_updated_at
boolean

When true, also require the alert's updated_at to fall within [start_time, end_time], in addition to the start_time filter; the span must then not exceed 7 days.

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

Paginated list of alerts.