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

TestSelfMonRule

Evaluate a self-monitoring rule against current metrics and return a sample alert.

POST/api/v1/self-monitor/rules/{ruleId}/test

Operation ID

TestSelfMonRule

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

Path Parameters

  • ruleId
    StringRequired

    ID of the rule to test against current metrics

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • id
    String

    Unique identifier of the fired alert

    Example: alert-001-xyz

  • ruleId
    String

    ID of the rule that triggered this alert

    Example: rule-selfmon-001

  • ruleName
    String

    Name of the rule that triggered this alert

    Example: High Error Rate

  • value
    Long

    Observed metric value that triggered the alert

    Example: 0.08

  • threshold
    Long

    Threshold that was exceeded

    Example: 0.05

  • severity
    String

    Severity level of the alert

    Example: warning

  • status
    String

    Current status of the alert (firing, resolved)

    Example: firing

  • firedAt
    String

    Fired at

    Example: 2026-01-15T08:00:00Z

  • resolvedAt
    String

    Resolved at

    Example: 2026-01-15T08:00:00Z

  • message
    String

    Human-readable summary of the alert condition

    Example: Error rate 8% exceeds threshold 5%