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
| Address | https://api.hanzo.ai/v1/sbom/health |
| Method | GET |
| Operation | get_sbom_health |
| Auth | Authorization: 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
| Status | Body | Meaning |
|---|---|---|
200 | SbomHealth | ok |
200 body — 4 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
datastore | body | boolean | — | Datastore reports whether the shared datastore connection this subsystem reads and writes through is established. |
service | body | string | — | Service names the subsystem answering: always "sbom". |
status | body | string | — | Status is the liveness verdict: always "ok" here, because the process answering at all IS the liveness fact. |
table | body | string | — | Table is the fully-qualified datastore table the components live in. |
Failure carries the platform error shape — see Errors.
Examples
hanzo sbom healthimport { Configuration, SbomApi } from 'hanzoai';
const api = new SbomApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getSbomHealth();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import SbomApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = SbomApi(client).get_sbom_health()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.SbomAPI.GetSbomHealth(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, sbom_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = sbom_api::get_sbom_health(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.SbomApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new SbomApi(client).getSbomHealth();curl https://api.hanzo.ai/v1/sbom/health \
-H "Authorization: Bearer $HANZO_API_KEY"Tool sbom, op get_sbom_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": "sbom",
"arguments": {
"op": "get_sbom_health",
"input": {}
}
}
}'How is this guide?