Platform
getHealth
Health check
Returns the health status of the API server.
Usage
const result = await api.platform.getHealth();Parameters
None.
Response
Promise<HealthResponse> — service is healthy.
Example
import { PgBeamClient } from "pgbeam";
const client = new PgBeamClient({
token: null,
baseUrl: "https://api.pgbeam.com",
});
const result = await client.api.platform.getHealth();Errors
| Status | Description |
|---|---|
| 429 | Rate limited. Try again later. |