Hanzo
OpenapiO11y

Fires a test notification for the posted rule definition and answers with how…

Fires a test notification for the posted rule definition and answers with how many series alerted and a status message.

POST /v1/o11y/testRule

Addresshttps://api.hanzo.ai/v1/o11y/testRule
MethodPOST
OperationTestRuleNotification
AuthAuthorization: Bearer $HANZO_API_KEY

Fires a test notification for the posted rule definition and answers with how many series alerted and a status message. The legacy path; prefer /rules/test. Editor gate.

Request

1 field, body application/json (required).

FieldInTypeRequiredDescription
(body)bodyanyyes

Response

StatusBodyMeaning
200o11y.O11yTestNotificationOutok

200 body — 4 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yTestNotificationResult
data.alertCountbodyintegerAlertCount is how many series would alert for the tested rule.
data.messagebodystringMessage is a human-readable status, e.g.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y testRule

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page