Pular para o conteúdo principal
GET
/
health
/
ready
Verificar prontidão do serviço
curl --request GET \
  --url https://plugin-br-bank-transfer.sandbox.lerian.net/health/ready
{
  "status": "UP",
  "checks": {
    "database": {
      "status": "UP",
      "critical": true
    },
    "cache": {
      "status": "UP",
      "critical": false
    },
    "mongo": {
      "status": "UP",
      "critical": true
    },
    "telemetry": {
      "status": "UP",
      "critical": false
    }
  },
  "timeoutMs": 5000
}

Resposta

Indica que o serviço está pronto para aceitar tráfego. O status é UP quando todas as dependências estão saudáveis, ou DEGRADED quando uma dependência opcional está indisponível.

​
status
enum<string>
obrigatório

Status geral do serviço. UP quando todas as dependências estão saudáveis, DEGRADED quando uma dependência opcional está indisponível, DOWN quando uma dependência obrigatória está indisponível.

Opções disponíveis:
UP,
DEGRADED,
DOWN
Exemplo:

"UP"

​
checks
object
obrigatório

Status de saúde de cada dependência.

​
timeoutMs
integer
obrigatório

Timeout usado para verificações de dependências, em milissegundos.

Exemplo:

5000