---
title: "platform health"
description: "Check API health status"
canonical: "https://pgbeam.com/docs/cli/platform/health"
last-updated: "2026-10-30T03:14:55.000Z"
---

# platform health

> Check API health status

URL: https://pgbeam.com/docs/cli/platform/health

{/* Auto-generated from CLI commands. Do not edit. Run `pnpm generate:cli-docs` to regenerate. */}

Check the health status of the PgBeam API. Returns the API status and version. This is a public endpoint that does not require authentication. Useful for verifying connectivity and checking which API version is running.

## Usage

```bash
pgbeam platform health
```

> **Global options**
>
> All [global options](/docs/cli/global-options) (`--token`, `--profile`,
> `--project`, `--org`, `--json`, `--no-color`, `--no-trunc`, `--debug`) are
> also available on this command.

## Examples

```bash
# Check API health
pgbeam platform health

# Get health status as JSON
pgbeam platform health --json
```

## Output

Displays the API status (e.g. `ok`) and version number. With `--json`, returns the full health response object.