Hanzo
OpenapiSbom

Health is a pure liveness probe: the service is up; datastore reflects whether…

Health is a pure liveness probe: the service is up; datastore reflects whether the datastore store is connected.

GET /v1/sbom/health

Addresshttps://api.hanzo.ai/v1/sbom/health
MethodGET
Operationget_sbom_health
AuthAuthorization: Bearer $HANZO_API_KEY

Health is a pure liveness probe: the service is up; datastore reflects whether the datastore store is connected. Not JWT-gated, always 200 (a disconnected datastore is degraded-but-alive; the data endpoints report that as 503).

Request

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

Response

StatusBodyMeaning
200SbomHealthok

200 body — 4 fields.

FieldInTypeAlwaysDescription
datastorebodybooleanDatastore reports whether the shared datastore connection this subsystem reads and writes through is established.
servicebodystringService names the subsystem answering: always "sbom".
statusbodystringStatus is the liveness verdict: always "ok" here, because the process answering at all IS the liveness fact.
tablebodystringTable is the fully-qualified datastore table the components live in.

Failure carries the platform error shape — see Errors.

Examples

hanzo sbom health

SBOM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page