List alerts

Return a cursor-paginated list of alerts matching the given filters.

POST /alert/list

List alerts

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/alert/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_time": 1712620800,
  "end_time": 1712707200,
  "limit": 20,
  "is_active": true
}
'

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "total": 1,
    "has_next_page": false,
    "search_after_ctx": "",
    "items": [
      {
        "alert_id": "663a1b2c3d4e5f6789abcdef",
        "integration_id": 10001,
        "channel_id": 20001,
        "account_id": 10023,
        "title": "CPU usage > 90%",
        "alert_severity": "Critical",
        "alert_status": "Critical",
        "start_time": 1712650000,
        "last_time": 1712655000,
        "end_time": 0,
        "labels": {
          "host": "web-01"
        },
        "ever_muted": false,
        "created_at": 1712650000,
        "updated_at": 1712655000,
        "integration_name": "Prometheus",
        "integration_type": "prometheus",
        "channel_name": "Production",
        "event_cnt": 3
      }
    ]
  }
}

Restrictions

Aspect	Value
Rate limits	1,000 requests/minute; 50 requests/second per account
Permissions	Channels Read (on-call)

Usage

• Both start_time and end_time are required Unix epoch seconds. Maximum span is 31 days.
• Use search_after_ctx from the previous response to fetch the next page.
• 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 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

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.

end_time · integer<int64> · required

End of the search window, Unix epoch seconds. Max span 31 days.

p · integer<int64>

Page number, starting at 1. Used when search_after_ctx is not provided.

limit · integer<int64>

Page size. Max 100, default 20.

search_after_ctx · string

Opaque cursor from the previous response for the next page.

is_active · boolean | null

Filter by active (true) or resolved (false) status.

ever_muted · boolean | null

Filter by whether the alert has ever been silenced.

alert_severity · string

Comma-separated severity filter, e.g. Critical,Warning. Allowed values: Critical, Warning, Info, 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).

alert_keys · string[]

Filter by alert deduplication keys.

orderby · enum<string>

Sort field.

Available options: created_at, updated_at

asc · boolean

Sort ascending when true. Default descending.

by_updated_at · boolean

When true, the time range filter is applied on updated_at rather than start_time.

Response

200

application/json

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.

Show child attributes