Hanzo AI
OpenapiDeploy

List health

Health reports whether this deployment can observe the delivery plane.

GET /v1/deploy/health

Addresshttps://api.hanzo.ai/v1/deploy/health
MethodGET
Operationget_deploy_health
AuthAuthorization: Bearer $HANZO_API_KEY

Health reports whether this deployment can observe the delivery plane.

200 only when the Kubernetes API answers AND the App custom resource is served; 503 with the same shape otherwise, naming which half failed. It reports BOOLEANS and never the underlying error, because the route is unauthenticated — liveness must be probe-able without a token — and a raw client error can disclose the apiserver address or an RBAC detail. That detail is logged server-side instead.

Request

GET /v1/deploy/health takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200deployHealthok
503deployHealthservice unavailable

200 body — 4 fields.

FieldInTypeAlwaysDescription
crdbodybooleanCRD reports whether the App custom resource is served and listable.
k8sbodybooleanK8s reports whether the Kubernetes API is reachable.
servicebodystringService names the subsystem answering, so a probe response is attributable when several are collected together.
statusbodystringStatus is ok when this deployment can serve the delivery plane, and degraded otherwise.

Failure carries the platform error shape — see Errors.

Examples

hanzo deploy health

Deploy API · All Hanzo APIs · Interactive reference

How is this guide?

On this page