Hanzo
OpenapiO11y

Reports how much of the Hanzo fleet is up — the current per-service inventory…

Reports how much of the Hanzo fleet is up — the current per-service inventory plus an up-versus-reporting trend across the window.

GET /v1/o11y/availability

Addresshttps://api.hanzo.ai/v1/o11y/availability
MethodGET
Operationget_o11y_availability
AuthAuthorization: Bearer $HANZO_API_KEY

Reports how much of the Hanzo fleet is up — the current per-service inventory plus an up-versus-reporting trend across the window. Both come from the fleet prober's own measurements: every service is asked its health URL every 30 seconds, so a service is listed as down because it did not answer, never because something failed to collect it. PLATFORM SUDO ONLY — this is the whole fleet's inventory, not tenant data, so every customer is 403. An unreachable telemetry store answers 503 rather than an empty trend, because a board of zeroes and a fleet that is down look identical.

Request

2 fields.

FieldInTypeRequiredDescription
rangequeryintegerRange is the trend window in seconds.
stepSecqueryintegerStepSec is the bucket width in seconds, clamped to [30, 3600].

Response

StatusBodyMeaning
200o11y.availabilityResponseok

200 body — 12 fields.

FieldInTypeAlwaysDescription
rangebodyobjectRange is the window and bucket width actually used, after clamping — not what was asked for, which is why a caller reads it back rather than assuming.
range.sinceSecbodyinteger
range.stepSecbodyinteger
seriesbodyo11y.availabilityPoint[]Series is the trend, oldest bucket first.
series[].tbodystringT is the bucket start, RFC3339 in UTC.
series[].totalbodyintegerTotal is how many services reported at all inside the bucket.
series[].upbodyintegerUp is how many services were up at the end of the bucket.
servicesbodyo11y.serviceUp[]Services is the current inventory, sorted by name so two reads of an unchanged fleet are byte-identical.
services[].namebodystringName is the service as the fleet prober knows it (probes.go's target name, which is the service label on hanzo_service_up).
services[].upbodybooleanUp is true when the service answered its own health URL on the last cycle.
totalbodyintegerTotal is how many services the prober currently watches.
upbodyintegerUp is how many services are up right now.

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y availability

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page