Skip to main content
GET
/
health
/
ready
Verificacao de Prontidao
curl --request GET \
  --url https://api.example.com/health/ready \
  --header 'Authorization: Bearer <token>'
{
  "status": "ok",
  "checks": {
    "database": "ok",
    "redis": "ok",
    "stripe": "ok",
    "workos": "ok"
  }
}
Verifica a conectividade com cada dependencia externa. Sempre retorna 200 — inspecione status e checks para determinar a prontidao.

​
Resposta

​
status
string
Status geral de prontidao. ok se todos os checks passaram, error se algum falhou.
​
checks
object
Status individual para cada servico externo.
​
checks.database
string
Conectividade com o banco de dados. ok ou error.
​
checks.redis
string
Conectividade com o Redis. ok ou error.
​
checks.stripe
string
Conectividade com o Stripe. ok ou error.
​
checks.workos
string
Conectividade com o WorkOS. ok ou error.
{
  "status": "ok",
  "checks": {
    "database": "ok",
    "redis": "ok",
    "stripe": "ok",
    "workos": "ok"
  }
}

​
Exemplos de Codigo

curl https://api.awsales.io/admin/health/ready
O check de prontidao sempre retorna 200 — inspecione os campos status e checks para determinar se todas as dependencias estao saudaveis.

​
Codigos de Erro

StatusCodigoDescricao
500internal_server_errorOcorreu um erro inesperado