Hanzo AI
OpenapiS3

List health

Health reports whether this deployment can serve object storage.

GET /v1/s3/health

Addresshttps://api.hanzo.ai/v1/s3/health
MethodGET
Operationget_s3_health
AuthAuthorization: Bearer $HANZO_API_KEY

Health reports whether this deployment can serve object storage.

It is a REAL probe rather than a constant: 200 when admin 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 bucket and bills nothing.

Request

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

Response

StatusBodyMeaning
200s3Healthok
503s3Healthservice unavailable

200 body — 5 fields.

FieldInTypeAlwaysDescription
errorbodystringError is why the probe is degraded, in plain words.
presignbodybooleanPresign is whether presigned upload and download URLs can be minted, which needs a PUBLIC endpoint on top of the credentials.
readybodybooleanReady is whether this deployment can serve object operations at all: true only when admin credentials are configured.
servicebodystringService names the subsystem this probe is for.
statusbodystringStatus is "ok" when the store is reachable in principle, "degraded" when it is not.

Failure carries the platform error shape — see Errors.

Examples

hanzo s3 health

S3 API · All Hanzo APIs · Interactive reference

How is this guide?

On this page