---
title: "health"
description: "Liveness and readiness. The `machinemail health` commands: arguments, flags, examples and the API routes they call."
canonical: "https://machinemail.dev/docs/cli/commands/health"
---

# health

> Liveness and readiness. The `machinemail health` commands: arguments, flags, examples and the API routes they call.

Source: https://machinemail.dev/docs/cli/commands/health

Liveness and readiness.

| Command                         | Summary                                           |
| ------------------------------- | ------------------------------------------------- |
| [`health check`](#health-check) | Check that the API is up (liveness)               |
| [`health ready`](#health-ready) | Check that the API can serve requests (readiness) |

Every command also takes the [global flags](https://machinemail.dev/docs/cli/commands#global-flags).

## health check

Check that the API is up (liveness).

Always 200 \{"status": "ok"} while the process serves requests. No authentication.

```bash
machinemail health check [flags]
```

#### Examples

```bash
machinemail health check
```

#### API

- [`GET /health`](https://machinemail.dev/docs/reference/api/health)

## health ready

Check that the API can serve requests (readiness).

Pings the storage backend: 200 with status: ready (checks.storage: true) when it answers, 503 with status: unavailable when it does not. No authentication.

```bash
machinemail health ready [flags]
```

#### Examples

```bash
machinemail health ready
```

#### API

- [`GET /health/ready`](https://machinemail.dev/docs/reference/api/health)