Skip to main content
ZStack
Alerting & Response/Alert Rules

GetAlertRuleCategories

List the rule category hierarchy for navigation and filtering

GET/api/v1/alerting/rules/categories

Operation ID

GetAlertRuleCategories

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Hierarchical list of rule categories

    Example: (nested array)

    • id
      String

      Category identifier

      Example: infrastructure

    • name
      String

      Display name for the category

      Example: Infrastructure

    • icon
      String

      Icon identifier for the category

      Example: server

    • children
      List

      Child categories in the hierarchy

      Example: (nested array)