---
title: "GetHealth"
description: "Health check"
canonical: "https://pgbeam.com/docs/go-sdk/platform/getHealth"
last-updated: "2026-10-29T19:01:20.000Z"
---

# GetHealth

> Health check

URL: https://pgbeam.com/docs/go-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

```go
result, err := client.Platform.GetHealth(ctx)
```

## Parameters

| Parameter | Type              | Required | Description     |
| --------- | ----------------- | -------- | --------------- |
| ctx       | `context.Context` | Yes      | Request context |

## Response

`(*pgbeam.HealthResponse, error)`: service is healthy.

## Example

```go
import pgbeam "go.pgbeam.com/sdk"

client := pgbeam.NewClient(&pgbeam.ClientOptions{
  APIKey: "pbu_...",
})

result, err := client.Platform.GetHealth(ctx)
if err != nil {
  log.Fatal(err)
}
fmt.Println(result)
```

## 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.                      |