platform
platform health
Check API health status
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
pgbeam platform healthGlobal options
All global options (--token, --profile,
--project, --org, --json, --no-color, --debug) are also available on
this command.
Examples
# Check API health
pgbeam platform health
# Get health status as JSON
pgbeam platform health --jsonOutput
Displays the API status (e.g. ok) and version number. With --json, returns
the full health response object.