> This page is for version v1.4.0.
> For other versions, use one of these documentation indexes:
> - Latest (v1.5.1) (default): https://docs.nvidia.com/dynamo/latest/llms.txt
> - dev: https://docs.nvidia.com/dynamo/dev/llms.txt
> - v1.5.1: https://docs.nvidia.com/dynamo/v1.5.1/llms.txt
> - v1.5.0: https://docs.nvidia.com/dynamo/v1.5.0/llms.txt
> - v1.4.2: https://docs.nvidia.com/dynamo/v1.4.2/llms.txt
> - v1.4.1: https://docs.nvidia.com/dynamo/v1.4.1/llms.txt
> - v1.4.0: https://docs.nvidia.com/dynamo/v1.4.0/llms.txt
> - v1.3.0: https://docs.nvidia.com/dynamo/v1.3.0/llms.txt
> - v1.2.1: https://docs.nvidia.com/dynamo/v1.2.1/llms.txt
> - v1.2.0: https://docs.nvidia.com/dynamo/v1.2.0/llms.txt
> - v1.1.1: https://docs.nvidia.com/dynamo/v1.1.1/llms.txt
> - v1.1.0: https://docs.nvidia.com/dynamo/v1.1.0/llms.txt
> - v1.0.2: https://docs.nvidia.com/dynamo/v1.0.2/llms.txt
> - v1.0.1: https://docs.nvidia.com/dynamo/v1.0.1/llms.txt
> - v1.0.0: https://docs.nvidia.com/dynamo/v1.0.0/llms.txt
> - v0.9.1: https://docs.nvidia.com/dynamo/v-0-9-1/llms.txt
> - v0.9.0: https://docs.nvidia.com/dynamo/v-0-9-0/llms.txt
> - v0.8.1: https://docs.nvidia.com/dynamo/v-0-8-1/llms.txt
> - v0.8.0: https://docs.nvidia.com/dynamo/v-0-8-0/llms.txt
> - v0.7.1: https://docs.nvidia.com/dynamo/v-0-7-1/llms.txt
> - v0.7.0: https://docs.nvidia.com/dynamo/v-0-7-0/llms.txt

> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.nvidia.com/dynamo/llms.txt. For full content including API reference and SDK examples, see https://docs.nvidia.com/dynamo/llms-full.txt.

# dynamo.health_check

`dynamo.health_check` publishes 1 classes and 1 functions. Source: [`lib/bindings/python/src/dynamo/health_check.py`](https://github.com/ai-dynamo/dynamo/blob/v1.4.0/lib/bindings/python/src/dynamo/health_check.py)

#### HealthCheckPayload (class)

Base class for managing health check payloads.

```python
from dynamo.health_check import HealthCheckPayload
```

```python
HealthCheckPayload()
```

Each backend should extend this class and set self.default\_payload
in their **init** method.

Environment variable DYN\_HEALTH\_CHECK\_PAYLOAD can override the default.

[`lib/bindings/python/src/dynamo/health_check.py#L75`](https://github.com/ai-dynamo/dynamo/blob/v1.4.0/lib/bindings/python/src/dynamo/health_check.py#L75)

**Public methods**

#### **init**

```python
__init__()
```

Initialize health check payload.

Subclasses should call super().**init**() after setting self.default\_payload.

[source](https://github.com/ai-dynamo/dynamo/blob/v1.4.0/lib/bindings/python/src/dynamo/health_check.py#L87)

#### to\_dict

```python
to_dict() -> Dict[str, Any]
```

Get the health check payload as a dictionary.

Returns the environment override if DYN\_HEALTH\_CHECK\_PAYLOAD is set,
otherwise returns the default payload.

[source](https://github.com/ai-dynamo/dynamo/blob/v1.4.0/lib/bindings/python/src/dynamo/health_check.py#L100)

#### load\_health\_check\_from\_env (function)

Load health check payload from environment variable.

```python
from dynamo.health_check import load_health_check_from_env
```

```python
load_health_check_from_env(env_var: str = 'DYN_HEALTH_CHECK_PAYLOAD') -> Optional[Dict[str, Any]]
```

Supports two formats:

1. JSON string: export DYN\_HEALTH\_CHECK\_PAYLOAD='\{"prompt": "test", "max\_tokens": 1}'
2. File path: export DYN\_HEALTH\_CHECK\_PAYLOAD='@/path/to/health\_check.json'

**Parameters**

**`env_var`** `str`

Name of the environment variable to check (default: DYN\_HEALTH\_CHECK\_PAYLOAD)

---

**Returns**

* `Optional[Dict[str, Any]]` — Dict containing the health check payload, or None if not set.

[`lib/bindings/python/src/dynamo/health_check.py#L33`](https://github.com/ai-dynamo/dynamo/blob/v1.4.0/lib/bindings/python/src/dynamo/health_check.py#L33)