List notification rules¶

Get the current user’s notification rule states, priorities, thresholds, and delivery channels.

GET https://billing.moi.matrixorigin.cn/api/v1/taas/notification-rules

Before you begin¶

Prepare a personal access token. For creation and management, see Manage personal access tokens.

Results are scoped to data accessible to the current user.

Request example¶

Replace $MOI_PERSONAL_ACCESS_TOKEN in the example with your personal access token.

curl --get "https://billing.moi.matrixorigin.cn/api/v1/taas/notification-rules" \
  -H "X-API-Key: $MOI_PERSONAL_ACCESS_TOKEN"

Successful response¶

Returns HTTP 200 with notification rule settings for the current user.

Response example

{
  "items": [
    {
      "rule_key": "usage_warning",
      "category": "usage",
      "title": "Usage warning",
      "description": "Usage threshold warning.",
      "enabled": true,
      "priority": "important",
      "threshold_value": "90",
      "threshold_unit": "percent",
      "threshold_readonly": true,
      "delivery_channels": [
        "in_app"
      ],
      "config_version": 1,
      "updated_at": 1788710400
    }
  ]
}

Fields

Field	Type	Description
`items`	array of object	Notification rules.
`items[].rule_key`	string	Rule identifier.
`items[].category`	string	Rule category.
`items[].title`	string	Rule title.
`items[].description`	string	Rule description.
`items[].enabled`	boolean	Whether the rule is enabled.
`items[].priority`	string	Notification priority.
`items[].threshold_value`	string	Threshold as a decimal string; omitted when not applicable.
`items[].threshold_unit`	string	Threshold unit; omitted when not applicable.
`items[].threshold_readonly`	boolean	Whether the threshold is read-only.
`items[].scope`	object	Rule-specific scope properties; omitted when unset.
`items[].delivery_channels`	array of string	Identifiers of currently available delivery channels.
`items[].tip`	string	Rule hint, when present.
`items[].config_version`	integer	Rule configuration version.
`items[].updated_at`	integer	Update time, Unix seconds.

In field paths, [] denotes each array item.

Last updated on Sep 15, 2026