Skip to main content
GET
/
health
Health Check
curl --request GET \
  --url https://api.example.com/health
{
  "status": "<string>",
  "timestamp": "<string>",
  "uptime": 123,
  "checks": {},
  "checks.database": "<string>",
  "checks.cache": "<string>"
}
Verifica se a API está operacional. Endpoint público utilizado por monitores de disponibilidade e pipelines de CI/CD. Retorna 200 OK quando todos os componentes críticos estão funcionando.

​
Resposta

​
status
string
Status geral da API. Valor: ok.
​
timestamp
string
Data/hora da verificacao (ISO 8601).
​
uptime
number
Tempo de execução do processo em segundos.
​
checks
object
Status individual de cada componente.
​
checks.database
string
Status do armazenamento primário: ok ou error.
​
checks.cache
string
Status da camada de cache: ok ou error.
curl -X GET https://api.linka.com/health

​
Exemplo de resposta

{
  "status": "ok",
  "timestamp": "2026-03-06T10:00:00.000Z",
  "uptime": 86400,
  "checks": {
    "database": "ok",
    "cache": "ok"
  }
}