Skip to main content
POST
List alert rules

Restrictions

Usage

  • folder_id must be an existing folder: 0 or an unknown ID returns InvalidParameter, and a folder the caller cannot manage (account owner or admin, creator of the folder or an ancestor, or member of the team bound to it or an ancestor) returns AccessDenied. There is no account-wide listing.
  • By default only the rules directly in the folder are returned, sorted by name, with active_alert_count and runtime_state filled.
  • With include_descendants: true the call searches the folder and all its descendant folders and returns at most limit rules sorted by name; only id, folder_id and name are filled and the other fields carry zero values (labels is null, runtime_state is omitted).
  • triggered is true exactly when active_alert_count > 0.

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 parameter for listing rules in a folder.

folder_id
integer<uint64>

ID of the folder to list. Must be an existing folder the caller can manage; 0 or an unknown ID returns InvalidParameter.

include_descendants
boolean

Also search all descendant folders. When true, results are sorted by name, capped by limit, and each item fills only id, folder_id and name (other fields carry zero values); combine with query for rule-picker scenarios.

query
string

Filter by rule name substring; a numeric value also matches the rule with that ID. 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[]

List of alert rules (basic info).