Hanzo
OpenapiKms

Reports whether this broker can actually serve secrets.

Reports whether this broker can actually serve secrets.

GET /v1/kms/health

Addresshttps://api.hanzo.ai/v1/kms/health
MethodGET
Operationget_kms_health
AuthAuthorization: Bearer $HANZO_API_KEY

Reports whether this broker can actually serve secrets.

A real readiness probe, not a liveness stub: 200 only when the store is open AND a master key is configured, with signing reporting whether signing keys are set up too. Anything less answers 503 with ready:false and the reason — no in-process store, or no master key — which are exactly the two states in which the secret operations refuse.

Not token-gated, because the platform must be able to probe it without a credential. It reports the broker's configuration state only; no secret, no key material and no tenant name appears in it.

Request

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

Response

StatusBodyMeaning
200kmsHealthok
503kmsHealthservice unavailable

200 body — 5 fields.

FieldInTypeAlwaysDescription
errorbodystringError is the honest reason readiness is false: no in-process KMS client, or no master key.
readybodybooleanReady is whether a secret operation would actually succeed right now.
servicebodystringService names the subsystem answering, kms.
signingbodybooleanSigning reports whether signing keys are configured.
statusbodystringStatus is ok or degraded, the one-word form of Ready.

Failure carries the platform error shape — see Errors.

Examples

hanzo kms health

KMS API · All Hanzo APIs · Interactive reference

How is this guide?

On this page