# List health

URL: https://docs.hanzo.ai/docs/openapi/sbom/get-sbom-health

> A pure liveness probe: the service is up; datastore reflects whether the datastore store is connected.

`GET /v1/sbom/health`

> [SBOM →](https://docs.hanzo.ai/docs/openapi/sbom) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                        |
| ------------- | -------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/sbom/health`  |
| **Method**    | `GET`                                  |
| **Operation** | `get_sbom_health`                      |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY` |

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`     | sbom.SbomHealth | ok      |
| `default` | problem-details | refused |

`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](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo sbom health
```

**SDK**

**.ts**

```ts
import { Configuration, SbomApi } from 'hanzoai';

const api = new SbomApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getSbomHealth();
```

**.py**

```python
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()
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.SbomAPI.GetSbomHealth(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::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?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.SbomApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new SbomApi(client).getSbomHealth();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/sbom/health \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

Tool `sbom`, op `get_sbom_health` — POST the JSON-RPC envelope to `https://api.hanzo.ai/v1/mcp`.

```bash
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": {}
         }
       }
     }'
```

---

[SBOM API](https://docs.hanzo.ai/docs/openapi/sbom) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)