Hanzo
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

Addresshttps://api.hanzo.ai/v1/o11y/settings/ttl
MethodPOST
Operationpost_o11y_settings_ttl
AuthAuthorization: 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).

FieldInTypeRequiredDescription
coldStorageDurationDaysbodyintegerColdStorageDurationDays is how old data must be before it moves, in days.
coldStorageVolumebodystringColdStorageVolume names the volume aged data moves to, when set.
defaultTTLDaysbodyintegerDefaultTTLDays is the retention for data no rule matches, in days.
ttlConditionsbodyo11y.O11yRetentionRule[]TTLConditions are ordered per-label rules; the first matching rule wins.
ttlConditions[].conditionsbodyo11y.O11yRetentionMatch[]Conditions all have to hold for the rule to match.
ttlConditions[].conditions[].keybodystringKey is the label to test.
ttlConditions[].conditions[].valuesbodystring[]Values are the label values the rule matches.
ttlConditions[].ttlDaysbodyintegerTTLDays is the retention applied when it does, in days.
typebodystringType is the signal the policy applies to — traces, metrics or logs.

Response

StatusBodyMeaning
200o11y.O11yRetentionSetOutok

200 body — 1 field.

FieldInTypeAlwaysDescription
messagebodystringMessage says what was done.

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y settings ttl create

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page