OpenapiO11y
Sets the org's retention policy for one signal: the default TTL in days,…
Sets the org's retention policy for one signal: the default TTL in days, ordered per-label retention rules, and optional cold-storage settings.
POST /v1/o11y/settings/ttl
| Address | https://api.hanzo.ai/v1/o11y/settings/ttl |
| Method | POST |
| Operation | post_o11y_settings_ttl |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Sets the org's retention policy for one signal: the default TTL in days, ordered per-label retention rules, and optional cold-storage settings.
Admin only, as the mux tree has always gated it (AdminAccess); the runtime's own gate enforces it.
Request
9 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
coldStorageDurationDays | body | integer | — | ColdStorageDurationDays is how old data must be before it moves, in days. |
coldStorageVolume | body | string | — | ColdStorageVolume names the volume aged data moves to, when set. |
defaultTTLDays | body | integer | — | DefaultTTLDays is the retention for data no rule matches, in days. |
ttlConditions | body | o11y.O11yRetentionRule[] | — | TTLConditions are ordered per-label rules; the first matching rule wins. |
ttlConditions[].conditions | body | o11y.O11yRetentionMatch[] | — | Conditions all have to hold for the rule to match. |
ttlConditions[].conditions[].key | body | string | — | Key is the label to test. |
ttlConditions[].conditions[].values | body | string[] | — | Values are the label values the rule matches. |
ttlConditions[].ttlDays | body | integer | — | TTLDays is the retention applied when it does, in days. |
type | body | string | — | Type is the signal the policy applies to — traces, metrics or logs. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | o11y.O11yRetentionSetOut | ok |
200 body — 1 field.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
message | body | string | — | Message says what was done. |
Failure carries the platform error shape — see Errors.
Examples
hanzo o11y settings ttl createimport { Configuration, O11yApi } from 'hanzoai';
const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postO11ySettingsTtl({ coldStorageDurationDays: 0, coldStorageVolume: "<coldStorageVolume>" });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_ttl(cold_storage_duration_days=0, cold_storage_volume="<coldStorageVolume>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.PostO11ySettingsTtl(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_ttl(&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).postO11ySettingsTtl();curl -X POST https://api.hanzo.ai/v1/o11y/settings/ttl \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"coldStorageDurationDays": 0,
"coldStorageVolume": "<coldStorageVolume>"
}'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?