OpenapiO11y
Sets one service's apdex threshold and the status codes excluded from its score.
Sets one service's apdex threshold and the status codes excluded from its score.
POST /v1/o11y/settings/apdex
| Address | https://api.hanzo.ai/v1/o11y/settings/apdex |
| Method | POST |
| Operation | post_o11y_settings_apdex |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Sets one service's apdex threshold and the status codes excluded from its score.
Admin only, as the mux tree has always gated it (AdminAccess); the runtime's own gate enforces it.
Request
3 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
excludeStatusCodes | body | string | — | ExcludeStatusCodes are status codes excluded from the score, comma separated. |
serviceName | body | string | — | ServiceName is the service the threshold applies to. |
threshold | body | number | — | Threshold is the satisfied-response time in seconds. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | o11y.O11yApdexSetOut | ok |
200 body — 3 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | o11y.O11yMessage | — | |
data.data | body | string | — | Data is the acknowledgment message. |
status | body | string | — | Status is "success". |
Failure carries the platform error shape — see Errors.
Examples
hanzo o11y settings apdex createimport { Configuration, O11yApi } from 'hanzoai';
const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postO11ySettingsApdex({ excludeStatusCodes: "<excludeStatusCodes>", serviceName: "<serviceName>" });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).post_o11y_settings_apdex(exclude_status_codes="<excludeStatusCodes>", service_name="<serviceName>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.PostO11ySettingsApdex(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::post_o11y_settings_apdex(&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).postO11ySettingsApdex();curl -X POST https://api.hanzo.ai/v1/o11y/settings/apdex \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"excludeStatusCodes": "<excludeStatusCodes>",
"serviceName": "<serviceName>"
}'The door reaches o11y through the o11y tool, which names its 340 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "get_o11y_alert_last"
}
}
}'How is this guide?