Hanzo
OpenapiIndex

Reports whether the search plane can serve.

Reports whether the search plane can serve. Answers the dialect's `{"status":"available"}` when the index store is readable.

GET /v1/index/health

Addresshttps://api.hanzo.ai/v1/index/health
MethodGET
Operationget_index_health
AuthAuthorization: Bearer $HANZO_API_KEY

Reports whether the search plane can serve.

Answers the dialect's {"status":"available"} when the index store is readable. It FAILS CLOSED — an unreadable store answers 503 with {"status":"unavailable"} rather than an empty result set, because a Meilisearch client probes this before it will use a server at all and a cheerful 200 over a broken volume turns "search is down" into "nothing matched". It requires no principal and reads no tenant data.

Request

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

Response

StatusBodyMeaning
200indexHealthok
503indexHealthservice unavailable

200 body — 1 field.

FieldInTypeAlwaysDescription
statusbodystringStatus is available when the store is readable and unavailable when it is not — the second answer rides a 503, so a pod with a broken volume is taken out…

Failure carries the platform error shape — see Errors.

Examples

hanzo index health

Index API · All Hanzo APIs · Interactive reference

How is this guide?

On this page