Get rule trigger status under folder

Return the rule trigger summary for all rules under a folder node and its descendants.

POST /monit/rule/status

Get rule trigger status under folder

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/monit/rule/status?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "folder_id": 100
}
'

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": [
    {
      "folder_id": 100,
      "folder_name": "Production",
      "rule_total": 10,
      "triggered_rule_count": 2
    }
  ]
}

Restrictions

Aspect	Value
Rate limits	1,000 requests/minute; 50 requests/second per account
Permissions	Alerting Rules Manage (monit)

Usage

• Set folder_id to 0 to get summary across all folders.
• If the folder contains too many rules, computation is skipped for self-protection.

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

folder_id · integer<uint64>

Folder ID. 0 for all.

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

Endpoint-specific payload. See each operation's 200 response schema.

Show child attributes