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

# Estado

> Verifique se a API do GetQR está a funcionar.

> [!NOTE]
>
> A API do GetQR está em versão beta e só está disponível para alguns espaços de trabalho. Os detalhes podem mudar antes do lançamento geral.

Aponte o seu monitor de disponibilidade para a verificação de estado. Não precisa de chave de API, não conta para os [limites de pedidos](https://docs.getqr.com/pt/api/rate-limits.md) e continua a responder mesmo com o resto da API desativado.

## Verificar o estado da API

`GET /api/v1/health`

**status** `string`

`ok` quando a API está a funcionar.

**version** `string`

Versão da API, atualmente `v1`.

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

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

O endpoint só aceita `GET`. Os outros métodos devolvem `405 method_not_allowed` com um cabeçalho `Allow: GET`.

## Próximos passos

> [card] [Introdução à API](https://docs.getqr.com/pt/api/introduction.md)

> [card] [Autenticação](https://docs.getqr.com/pt/api/authentication.md)


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