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
| Address | https://api.hanzo.ai/v1/o11y/testRule |
| Method | POST |
| Operation | TestRuleNotification |
| Auth | Authorization: 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).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
(body) | body | any | yes |
Response
| Status | Body | Meaning |
|---|---|---|
200 | o11y.O11yTestNotificationOut | ok |
200 body — 4 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | o11y.O11yTestNotificationResult | — | |
data.alertCount | body | integer | — | AlertCount is how many series would alert for the tested rule. |
data.message | body | string | — | Message is a human-readable status, e.g. |
status | body | string | — | Status is "success". |
Failure carries the platform error shape — see Errors.
Examples
hanzo o11y testRuleimport { Configuration, O11yApi } from 'hanzoai';
const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.testRuleNotification();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import O11yApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = O11yApi(client).test_rule_notification()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.TestRuleNotification(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, o11y_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = o11y_api::test_rule_notification(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new O11yApi(client).testRuleNotification();curl -X POST https://api.hanzo.ai/v1/o11y/testRule \
-H "Authorization: Bearer $HANZO_API_KEY"Tool o11y, op TestRuleNotification — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "o11y",
"arguments": {
"op": "TestRuleNotification",
"input": {}
}
}
}'How is this guide?