Skip to main content
POST
List alert rules

Restrictions

Usage

  • Set folder_id to 0 to list all rules across all folders visible to the current user.
  • The triggered field indicates whether the rule has any currently active 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 parameter for listing rules in a folder.

folder_id
integer<uint64>

Folder ID. Must be an existing folder; 0 is rejected with a folder_not_found error.

include_descendants
boolean

Also include rules from all descendant folders. When true, each returned item carries only id, folder_id and name; combine with query / limit for rule-picker scenarios.

query
string

Rule name fuzzy filter; only effective when include_descendants is true.

limit
integer
default:50

Max number of rules returned; only effective when include_descendants is true. Defaults to 50, capped at 100.

Required range: 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 alert rules (basic info).