# Verificar saúde da API

`GET /health`

Pasta: **Sistema**

## Autenticação

Nenhuma (rota pública) ou herda auth da collection.

## Descrição

# Verificar saúde da API

Confirma se a API está no ar e respondendo. Use em monitoramento, probes de infraestrutura e checagens rápidas de disponibilidade.

## Endpoint

`GET {{baseUrl}}/health`

## Autenticação

Não requer autenticação.

## Exemplo de Requisição

```bash
curl --request GET '{{baseUrl}}/health'
```

## Resposta de Sucesso

```json
{
  "status": "ok",
  "client_name": "develop"
}
```

## Erros comuns

- Sem resposta / timeout: a API ou a rede estão indisponíveis.
- Código diferente de `200`: o serviço pode estar em falha parcial — verifique logs e `/health/overview`.

## Observações

- Resposta leve, sem dados de sessões ou métricas.
- Ideal para liveness/readiness probes.

## cURL

```bash
curl -X GET "{{baseUrl}}/health"
```

---

[Índice da pasta](./index.md) · [Índice geral](../index.md) · [UI](https://gozap.dev/docs?op=sistema/verificar-saude-da-api)