Skip to main content
API Explorer|API Explorer
Platform Operations/Platform Self-Monitor
GETPlatformSince 1.0SynchronousAuth Required

ListSelfMonRules

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    List of self-monitoring alert rules

    Example: (nested array)

    • idString

      Unique identifier of the alert rule

      Example: rule-selfmon-001

    • nameString

      Human-readable name of the alert rule

      Example: High Error Rate

    • descriptionString

      Description of what this self-monitoring rule detects

      Example: Fires when API error rate exceeds threshold

    • severityString

      Severity level of alerts fired by this rule

      Example: warning

    • thresholdLong

      Threshold value that triggers this rule

      Example: 0.05

    • builtinBoolean

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

      Example: true

  • totalInteger

    Total number of rules

    Example: 10

  • limitInteger

    Maximum number of items per page

    Example: 20

  • offsetInteger

    Number of items skipped

    Example: 20

Endpoint

GET/api/v1/self-monitor/rules

/api/v1/self-monitor/rules

Operation ID

ListSelfMonRules

Permalink

Request Example

curl -X GET '{host}/api/v1/self-monitor/rules' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ],
  "total": 10,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history