# List health

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

> Reports whether this deployment can observe the delivery plane.

`GET /v1/deploy/health`

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

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

Reports whether this deployment can observe the delivery plane.

200 only when the Kubernetes API answers AND the App custom resource is served;
503 with the same shape otherwise, naming which half failed. It reports BOOLEANS
and never the underlying error, because the route is unauthenticated — liveness
must be probe-able without a token — and a raw client error can disclose the
apiserver address or an RBAC detail. That detail is logged server-side instead.

## Request

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

## Response

| Status    | Body                | Meaning             |
| --------- | ------------------- | ------------------- |
| `200`     | deploy.deployHealth | ok                  |
| `503`     | deploy.deployHealth | service unavailable |
| `default` | problem-details     | refused             |

`200` body — 4 fields.

| Field     | In   | Type    | Always | Description                                                                                                     |
| --------- | ---- | ------- | ------ | --------------------------------------------------------------------------------------------------------------- |
| `crd`     | body | boolean | —      | CRD reports whether the App custom resource is served and listable.                                             |
| `k8s`     | body | boolean | —      | K8s reports whether the Kubernetes API is reachable.                                                            |
| `service` | body | string  | —      | Service names the subsystem answering, so a probe response is attributable when several are collected together. |
| `status`  | body | string  | —      | Status is `ok` when this deployment can serve the delivery plane, and `degraded` otherwise.                     |

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

## Examples

**CLI**

```bash
hanzo deploy health
```

**SDK**

**.ts**

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

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

**.py**

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

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

**.go**

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

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

**.rs**

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

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

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

**.java**

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

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

var result = new DeployApi(client).getDeployHealth();
```

**HTTP**

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

**MCP**

Tool `deploy`, op `get_deploy_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": "deploy",
         "arguments": {
           "op": "get_deploy_health",
           "input": {}
         }
       }
     }'
```

---

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