# List health

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

> Reports that the base subsystem is serving.

`GET /v1/base/health`

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

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

Reports that the base subsystem is serving.

It is deliberately INDEPENDENT of whether this deployment actually embeds the
Base engine: the route answers before the CLOUD\_BASE\_EMBED gate and before the
/v1/base/\* wildcard, so a liveness probe measures the process rather than an
optional feature, and the wildcard can never shadow it. It reads no tenant, so a
prober that sends no principal is answered rather than refused.

## Request

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

## Response

| Status    | Body            | Meaning |
| --------- | --------------- | ------- |
| `200`     | base.baseHealth | ok      |
| `default` | problem-details | refused |

`200` body — 2 fields.

| Field     | In   | Type   | Always | Description                                   |
| --------- | ---- | ------ | ------ | --------------------------------------------- |
| `service` | body | string | —      | Service is "base" — which subsystem answered. |
| `status`  | body | string | —      | Status is "ok" when the subsystem is serving. |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo base health
```

**SDK**

**.ts**

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

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

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import BaseApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = BaseApi(client).get_base_health()
```

**.go**

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

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

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, base_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = base_api::get_base_health(&cfg, Default::default()).await?;
```

**.java**

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

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

var result = new BaseApi(client).getBaseHealth();
```

**HTTP**

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

**MCP**

Tool `base`, op `get_base_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": "base",
         "arguments": {
           "op": "get_base_health",
           "input": {}
         }
       }
     }'
```

---

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