Skip to main content
ZStack
Platform Operations/Platform Self-Monitor

ListSelfMonRules

List all self-monitoring alert rules including built-in and custom rules.

GET/api/v1/self-monitor/rules

Operation ID

ListSelfMonRules

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

    List of self-monitoring alert rules

    Example: (nested array)

    • id
      String

      Unique identifier of the alert rule

      Example: rule-selfmon-001

    • name
      String

      Human-readable name of the alert rule

      Example: High Error Rate

    • description
      String

      Description of what this self-monitoring rule detects

      Example: Fires when API error rate exceeds threshold

    • severity
      String

      Severity level of alerts fired by this rule

      Example: warning

    • threshold
      Long

      Threshold value that triggers this rule

      Example: 0.05

    • builtin
      Boolean

      Whether this rule is a built-in system rule (not user-modifiable)

      Example: true

  • total
    Integer

    Total number of rules

    Example: 10

  • limit
    Integer

    Maximum number of items per page

    Example: 20

  • offset
    Integer

    Number of items skipped

    Example: 20