---
title: "getHealth"
description: "Health check"
canonical: "https://pgbeam.com/docs/ts-sdk/platform/getHealth"
last-updated: "2026-10-30T02:48:39.000Z"
---

# getHealth

> Health check

URL: https://pgbeam.com/docs/ts-sdk/platform/getHealth

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

Returns the health status of the API server.

## Usage

```typescript
const result = await api.platform.getHealth();
```

## Parameters

None.

## Response

`Promise<HealthResponse>`: service is healthy.

## Example

```typescript
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                                                                                                                         |
| ------ | ----------------------------------------------------------------------------------------------------------------------------------- |
| 400    | The request was rejected. `code` is `INVALID_INPUT`, and `errors` names the offending fields when the failure was a validation one. |
| 429    | Rate limited. `code` is `RATE_LIMITED`.                                                                                             |
| 500    | The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it.                      |