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
| Address | https://api.hanzo.ai/v1/index/health |
| Method | GET |
| Operation | get_index_health |
| Auth | Authorization: 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
| Status | Body | Meaning |
|---|---|---|
200 | indexHealth | ok |
503 | indexHealth | service unavailable |
200 body — 1 field.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
status | body | string | — | Status 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 healthimport { Configuration, IndexApi } from 'hanzoai';
const api = new IndexApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getIndexHealth();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import IndexApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = IndexApi(client).get_index_health()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.IndexAPI.GetIndexHealth(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, index_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = index_api::get_index_health(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.IndexApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new IndexApi(client).getIndexHealth();curl https://api.hanzo.ai/v1/index/health \
-H "Authorization: Bearer $HANZO_API_KEY"Tool index, op get_index_health — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "index",
"arguments": {
"op": "get_index_health",
"input": {}
}
}
}'How is this guide?