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

TestSelfMonRule

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

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • ruleIdStringRequired

    ID of the rule to test against current metrics

Responses

200 OK

On success, this API returns the following response structure.

  • idString

    Unique identifier of the fired alert

    Example: alert-001-xyz

  • ruleIdString

    ID of the rule that triggered this alert

    Example: rule-selfmon-001

  • ruleNameString

    Name of the rule that triggered this alert

    Example: High Error Rate

  • valueLong

    Observed metric value that triggered the alert

    Example: 0.08

  • thresholdLong

    Threshold that was exceeded

    Example: 0.05

  • severityString

    Severity level of the alert

    Example: warning

  • statusString

    Current status of the alert (firing, resolved)

    Example: firing

  • firedAtString

    Fired at

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

  • resolvedAtString

    Resolved at

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

  • messageString

    Human-readable summary of the alert condition

    Example: Error rate 8% exceeds threshold 5%

Endpoint

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

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

Operation ID

TestSelfMonRule

Permalink

Request Example

curl -X POST '{host}/api/v1/self-monitor/rules/{ruleId}/test' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{}'

Response Example

200
{
  "id": "alert-001-xyz",
  "ruleId": "rule-selfmon-001",
  "ruleName": "High Error Rate",
  "value": 0.08,
  "threshold": 0.05,
  "severity": "warning",
  "status": "firing",
  "firedAt": "example"
}

Change History

This API has no change history records yet.

View all change history