Skip to main content
POST
Get alert rule detail (V2)

Restrictions

Usage

  • id is required and must not be 0; otherwise the call returns InvalidParameter.
  • A missing rule, or a rule of another account, returns InvalidParameter (alert rule not found).
  • The caller must have access to the rule’s folder (the account owner or an admin, the creator of the folder or an ancestor, or a member of the team bound to it or an ancestor); otherwise the call returns AccessDenied. A rule whose folder no longer exists returns InvalidParameter (folder not found).

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
id
integer<uint64>
required

Alert rule ID. Obtainable per folder via POST /monit/rule/list/basic.

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

Complete V2 alert rule configuration. The core difference from V1 lives in rule_configs: the three checkers describe recovery and ending semantics with the lifecycle v2 recovery_mode/end_mode enums.