Hanzo
OpenapiPlan

Health reports that the plans subsystem is mounted and serving.

Health reports that the plans subsystem is mounted and serving.

GET /v1/plan/health

Addresshttps://api.hanzo.ai/v1/plan/health
MethodGET
Operationget_plan_health
AuthAuthorization: Bearer $HANZO_API_KEY

Health reports that the plans subsystem is mounted and serving. It answers from the process itself and consults neither the catalog bundle nor the goja host, so it stays "ok" while either is degraded.

Request

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

Response

StatusBodyMeaning
200planHealthok

200 body — 2 fields.

FieldInTypeAlwaysDescription
servicebodystringService names the subsystem that answered.
statusbodystringStatus is "ok" whenever this subsystem is mounted.

Failure carries the platform error shape — see Errors.

Examples

hanzo plans health

Plan API · All Hanzo APIs · Interactive reference

How is this guide?

On this page