List health
Health reports whether this deployment can serve spaces, drives and files.
GET /v1/space/health
| Address | https://api.hanzo.ai/v1/space/health |
| Method | GET |
| Operation | get_space_health |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Health reports whether this deployment can serve spaces, drives and files.
It is a REAL probe rather than a constant: 200 when object-store credentials are present, so the store is reachable in principle, and 503 with the reason when they are not. It is deliberately NOT gated — liveness has to be probe-able without a token — so it is the one operation here that names no space and bills nothing.
Request
GET /v1/space/health takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | space.spaceHealth | ok |
503 | space.spaceHealth | service unavailable |
default | problem-details | refused |
200 body — 5 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
error | body | string | — | Error is why the probe is degraded, in plain words. |
presign | body | boolean | — | Presign is whether upload and download URLs can be minted, which needs a PUBLIC endpoint on top of the credentials. |
ready | body | boolean | — | Ready is whether this deployment can serve drive and file operations at all: true only when object-store credentials are configured. |
service | body | string | — | Service names the subsystem this probe is for. |
status | body | string | — | Status is "ok" when the store is reachable in principle, "degraded" when it is not. |
Failure carries the platform error shape — see Errors.
Examples
hanzo space healthimport { Configuration, SpaceApi } from 'hanzoai';
const api = new SpaceApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getSpaceHealth();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import SpaceApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = SpaceApi(client).get_space_health()cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.SpaceAPI.GetSpaceHealth(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::apis::{configuration::Configuration, space_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = space_api::get_space_health(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.SpaceApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new SpaceApi(client).getSpaceHealth();curl https://api.hanzo.ai/v1/space/health \
-H "Authorization: Bearer $HANZO_API_KEY"MCP declares no tool for space — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.
How is this guide?