> ## Documentation Index
> Fetch the complete documentation index at: https://api-reference.hyperswitch.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Health Checks

> Curl examples for /health, /health/ready, and /health/diagnostics.

# Health Checks

Health routes are public and do not require `AUTH_HEADER`. `/health/diagnostics` is the one exception — it needs `x-tenant-id`, see below.

## Liveness

```bash theme={null}
curl "$BASE_URL/health"
```

```json theme={null}
{ "message": "Health is good" }
```

## Readiness

```bash theme={null}
curl "$BASE_URL/health/ready"
```

```json theme={null}
{ "message": "Up" }
```

## Diagnostics

Unlike `/health` and `/health/ready`, this route resolves a tenant and requires `x-tenant-id` — omitting it fails with `TE_03: x-tenant-id not found in headers` even though no `AUTH_HEADER` is needed. `public` is the only tenant the shipped config files define.

```bash theme={null}
curl "$BASE_URL/health/diagnostics" \
  --header "x-tenant-id: public"
```

```json theme={null}
{
  "key_custodian_locked": false,
  "database": {
    "database_connection": "Working",
    "database_read": "Working",
    "database_write": "Working",
    "database_delete": "Working"
  }
}
```