GET
/health/readyVerificar banco acessível
200 não significa instância conectada nem integração homologada.
Autenticação
Endpoint público, sem token.
Base URL: a API do servidor selecionado, como https://1.atendro.cloud. O domínio wpp.atendro.cloud hospeda a documentação e o console.
Headers adicionais
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
X-Request-Id | string | opcional | ASCII visível sem espaços, 1–128 caracteres. Inválido/ausente é substituído por UUID. Ecoado na resposta. Comprimento máximo: 128 |
Corpo da requisição
Não há corpo de requisição definido para esta operação.
Respostas
Verificar banco acessível
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
status | string | obrigatório | Valores: "alive", "ready", "not_ready" |
reason | string | opcional | Valores: "database_unreachable" |
Banco inacessível: status=not_ready, reason=database_unreachable.
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
status | string | obrigatório | Valores: "alive", "ready", "not_ready" |
reason | string | opcional | Valores: "database_unreachable" |
Falha; usar HTTP status e error. 404 rota inexistente; 405 método inválido com Allow. Ver catálogo no guia de integração.
| Campo | Tipo | Presença | Descrição |
|---|---|---|---|
error | string | obrigatório | — |
message | string | opcional | — |
messageid | string | opcional | ID para reconciliação quando o resultado é ambíguo. |
messageId | string | opcional | — |
id | string | opcional | — |
provider_code | integer | opcional | — |
error_key | string | opcional | — |
error_source | string | opcional | — |
details | object | opcional | — |
instance | object | opcional | Modelo: Instance. |