> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cyborg.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Health

Returns the health status of the CyborgDB service, to check that it is reachable and running.

```python theme={null}
client.get_health()
```

### Returns

`Dict[str, str]` with these keys:

| Key | Description |
| - | - |
| `status` | Service health, `"healthy"` when the service is up. |
| `api_version` | REST API version, e.g. `"v1"`. |
| `version` | CyborgDB service version. |

### Exceptions

<AccordionGroup>
  <Accordion title="cyborgdb.TransportError">
    The service can't be reached.
  </Accordion>

  <Accordion title="cyborgdb.ServiceError">
    The service returns `5xx`.
  </Accordion>
</AccordionGroup>

See [Errors](../errors) for the full hierarchy.

### Example Usage

```python theme={null}
from cyborgdb import Client

client = Client(base_url='http://localhost:8000', api_key='your-api-key')

health = client.get_health()
print(health)
# Output: {'status': 'healthy', 'api_version': 'v1', 'version': '0.18.0'}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.