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

# Verificação de estado

> Sonda pública de prontidão para monitorização de disponibilidade

Uma sonda de prontidão pública para monitorização externa de disponibilidade. Este é o único endpoint que funciona **sem autenticação** — não envies nenhum cabeçalho `x-api-key`.

> [!NOTE]
>
> Para o estado operacional em tempo real, o estado por serviço e o histórico de incidentes, consulta a nossa
> página [Estado do sistema](https://docs.anivahealth.com/pt/status.md).

A verificação é uma sonda de prontidão, não apenas um ping de atividade: confirma que o processo da API está ativo **e** que a sua base de dados está acessível. Se não for possível aceder à base de dados, o endpoint devolve `503` para que um monitor nunca indique a API como saudável enquanto não consegue responder a pedidos de parceiros.

As respostas são enviadas com `Cache-Control: no-store`, pelo que cada pedido chega à origem em vez de receber uma resposta em cache de edge.

## Pedido

Este endpoint não recebe parâmetros nem requer autenticação.

## Resposta

Em caso de sucesso, a API devolve `200 OK`. Quando a base de dados está inacessível, devolve `503 Service Unavailable` com a mesma estrutura de corpo.

**status** `"ok" | "error"` *required*

`ok` quando o serviço e a sua base de dados estão acessíveis, `error` caso contrário.

**timestamp** `string` *required*

Instante UTC em ISO 8601 em que a verificação foi executada (por ex., `2026-06-27T08:30:00.000Z`).

## Códigos de estado

| Estado | Descrição |
| - | - |
| `200` | O serviço e a base de dados estão acessíveis. |
| `503` | O serviço não está saudável — a base de dados está inacessível. |

```bash cURL theme={null}
curl --url 'https://anivahealth.com/api/v1/health'
```

```json 200 theme={null}
{
  "status": "ok",
  "timestamp": "2026-06-27T08:30:00.000Z"
}
```

```json 503 theme={null}
{
  "status": "error",
  "timestamp": "2026-06-27T08:30:00.000Z"
}
```


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