> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getqr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Health

> Check that the GetQR API is up.

> [!NOTE]
>
> The GetQR API is in beta and is available to selected workspaces. Details may change before the general release.

Point your uptime monitor at the health check. It needs no API key, doesn't count toward [rate limits](https://docs.getqr.com/api/rate-limits.md) and keeps answering even while the rest of the API is switched off.

## Check API health

`GET /api/v1/health`

**status** `string`

`ok` when the API is up.

**version** `string`

API version, currently `v1`.

```bash cURL theme={null}
curl "https://getqr.com/api/v1/health"
```

```json 200 theme={null}
{ "status": "ok", "version": "v1" }
```

The endpoint accepts only `GET`. Other methods return `405 method_not_allowed` with an `Allow: GET` header.

## What's next

> [card] [API introduction](https://docs.getqr.com/api/introduction.md)

> [card] [Authentication](https://docs.getqr.com/api/authentication.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.