Hanzo
OpenapiDeploy

Whether this control plane can actually reach the cluster it deploys to

Reports the plane's real reachability: 200 only when the Kubernetes API server answers AND the App CRD is served, 503 with the same body shape otherwise,…

GET /v1/deploy/health

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

Reports the plane's real reachability: 200 only when the Kubernetes API server answers AND the App CRD is served, 503 with the same body shape otherwise, so a caller reads the same k8s and crd booleans either way rather than parsing an error envelope. It is a genuine dependency probe, not a process liveness ping — a running plane with no cluster behind it reports degraded.

This is the ONE unauthenticated route that reports state, because liveness must be probe-able without a JWT. It therefore discloses booleans only: the underlying failure — the API server address, an RBAC refusal — is logged server-side and never put on the wire.

Request

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

Response

The document declares no response body for this operation. It answers 200 on success and the platform error shape on failure — see Errors.

Examples

hanzo deploy health

Deploy API · All Hanzo APIs · Interactive reference

How is this guide?

On this page