v20

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-07-2176162684.2 KB
Utilitários

Verificar status da API

Endpoint de Health Check para monitoramento da disponibilidade e saúde da API.

O que Retorna

  • status — Status do sistema (ok ou error)
  • timestamp — Data/hora da verificação (ISO 8601)
  • uptime — Tempo de atividade do servidor (segundos)
  • database.status — Saúde do banco de dados (ok ou error)
  • database.latencyMs — Latência da conexão com o banco (ms)

Exemplo de Uso

curl "https://brapi.dev/health"

Caso de Uso

Ideal para monitoramento com ferramentas como UptimeRobot, Datadog, ou checks de disponibilidade em pipelines CI/CD.

Plano Mínimo: Gratuito Autenticação: Não necessária (Público)

get/health

Response

API operando normalmente.

status'ok' required
timestampstring date-time required
uptimenumber required

Example response

{
  "status": "ok",
  "timestamp": "2026-02-08T16:25:38.608Z",
  "uptime": 866.658018047,
  "database": {
    "status": "ok",
    "latencyMs": 1
  }
}
All 76 operations