Hanzo
OpenapiO11y

Reports whether a product's service is live: an in-cluster health probe with…

Reports whether a product's service is live: an in-cluster health probe with its measured latency, fused with the per-replica up inventory.

GET /v1/o11y/status

Addresshttps://api.hanzo.ai/v1/o11y/status
MethodGET
Operationget_o11y_status
AuthAuthorization: Bearer $HANZO_API_KEY

Reports whether a product's service is live: an in-cluster health probe with its measured latency, fused with the per-replica up inventory. Infra health is not tenant-partitioned — a service is up or down for everyone — so any validated caller is served, but an unvalidated one is refused. A product with no backing workload answers down/unknown-service without probing anything; a malformed slug is a 400.

Request

1 field.

FieldInTypeRequiredDescription
productquerystringProduct is the console product slug to probe, e.g.

Response

StatusBodyMeaning
200o11y.statusResultok

200 body — 8 fields.

FieldInTypeAlwaysDescription
checkedAtbodystringCheckedAt is when this answer was measured, RFC3339 UTC.
deploymentsbodyo11y.deployment[]Deployments is the per-replica inventory behind the verdict.
deployments[].instancebodystringInstance is the replica as the telemetry store labels it — the address the series was recorded against, which is what distinguishes two replicas of one service.
deployments[].upbodybooleanUp is that replica's last reported state. Every target emits on every cycle, so a replica missing from the list is one the prober is not reporting at all,…
latencyMsbodyintegerLatencyMs is the health probe's round trip in MILLISECONDS, time-boxed at two seconds.
productbodystringProduct is the service this answer is about, echoed back.
sourcebodystringSource is where the verdict came from: "probe" (we asked and it answered), "datastore" (the probe did not answer and the replica inventory decided it),…
upbodybooleanUp is true when the health probe succeeded OR any replica reports up, so a service reachable by either route reads up.

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y status

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page