Returns the org's current retention policy: default TTL, custom per-label…

Returns the org's current retention policy: default TTL, custom per-label rules, and cold-storage settings where configured.

GET /v1/o11y/settings/ttl

O11y → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/o11y/settings/ttl`
Method	`GET`
Operation	`get_o11y_settings_ttl`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns the org's current retention policy: default TTL, custom per-label rules, and cold-storage settings where configured.

Callers need the viewer role; the runtime's own gate enforces it.

Request

GET /v1/o11y/settings/ttl takes no parameters and no body — the credential is the whole request.

Response

Status	Body	Meaning
`200`	o11y.O11yRetentionOut	ok

200 body — 12 fields.

Field	In	Type	Always	Description
`cold_storage_ttl_days`	body	integer	—	ColdStorageTTLDays is how old data must be before it moves, in days.
`cold_storage_volume`	body	string	—	ColdStorageVolume names the volume aged data moves to.
`default_ttl_days`	body	integer	—	DefaultTTLDays is the retention for data no rule matches, in days.
`expected_logs_move_ttl_duration_hrs`	body	integer	—	ExpectedLogsMoveTTLHours is the pending logs cold-storage move TTL, in hours.
`expected_logs_ttl_duration_hrs`	body	integer	—	ExpectedLogsTTLHours is the pending logs TTL, in hours.
`status`	body	string	—	Status is the last TTL operation's state.
`ttl_conditions`	body	o11y.O11yRetentionRule[]	—	TTLConditions are the ordered per-label rules; the first match wins.
`ttl_conditions[].conditions`	body	o11y.O11yRetentionMatch[]	—	Conditions all have to hold for the rule to match.
`ttl_conditions[].conditions[].key`	body	string	—	Key is the label to test.
`ttl_conditions[].conditions[].values`	body	string[]	—	Values are the label values the rule matches.
`ttl_conditions[].ttlDays`	body	integer	—	TTLDays is the retention applied when it does, in days.
`version`	body	string	—	Version is the policy format version.

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y settings ttl get

import { Configuration, O11yApi } from 'hanzoai';

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getO11ySettingsTtl();

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).get_o11y_settings_ttl()

cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)

resp, _, err := client.O11yAPI.GetO11ySettingsTtl(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::get_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).getO11ySettingsTtl();

curl https://api.hanzo.ai/v1/o11y/settings/ttl \
  -H "Authorization: Bearer $HANZO_API_KEY"

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"
         }
       }
     }'

O11y API · All Hanzo APIs · Interactive reference

Returns the org's current retention policy: default TTL, custom per-label…

Request

Response

Examples

On this page