Alerts

Create / toggle / delete alert rule

A personal scope holds at most 20 alert rules; creating another returns 400 "alert_rule_limit_reached".

post/dashboard/alert-rules

Request

  • Base URL: https://blockreq.com/api
  • URL: https://blockreq.com/api/dashboard/alert-rules
  • Auth: HTTP bearer

Request body

action'create' | 'toggle' | 'delete' required
type'usage_percent' | 'error_rate' | 'package_expiry' | 'balance_low' | 'ru_usage'

Rule type for action "create". "ru_usage" is a deprecated alias of "usage_percent", stored as "usage_percent" and removed on 2027-01-01.

thresholdnumber
channelstring
ruleIdnumber
enabledboolean
labelstring nullable

Rule label for action "create", at most 64 characters.

Response

Result

codenumber required
okboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.