Status
Sondas de disponibilidade e o estado da plataforma. Sem autenticação.
Verificar se a API está no ar
GET/healthz
Responde 200 quando o processo está de pé. Não exige autenticação e não consulta banco nem fila, porque é sonda de processo e não de dependência. Um 200 aqui não promete que o envio de mensagem está funcionando.
Respostas
200Sucesso.
Ver se a Luna está recebendo e entregando
GET/status
Responde 200 com o estado da plataforma, medido a cada poucos minutos por uma mensagem sintética que entra pela mesma porta que a Meta usa e precisa chegar a um destino por HTTPS. Não exige autenticação e não revela dado de nenhuma conta. Quando ainda não há verificação recente, o estado é unknown, e nunca ok.
Respostas
200Sucesso.
statusstringobrigatórioO veredito geral. ok: a entrada e a entrega funcionam. degraded: uma verificação falhou e ainda não se repetiu, ou o horizonte de partições do banco está curto. down: a entrada ou a entrega falhou em verificações seguidas. unknown: ainda não há verificação recente.Valores:okdegradeddownunknowncheckedAtstring | nullobrigatórioQuando a última verificação terminou, em UTC. Nulo se nunca houve.componentsobjectobrigatórioCada parte do caminho, medida de ponta a ponta por uma mensagem sintética.components.ingestionstringobrigatórioA porta que recebe os webhooks da Meta.Valores:okdegradeddownunknowncomponents.deliverystringobrigatórioA entrega de um evento recebido ao destino, por HTTPS.Valores:okdegradeddownunknowncomponents.partitionsstringobrigatórioO horizonte de partições futuras do banco.Valores:okdegradeddownunknownsincestring | nullobrigatórioDesde quando o veredito geral é o atual, em UTC. Nulo se unknown.
Apresentar a API
GET/
Responde 200 com o nome da API e os endereços da documentação e da especificação OpenAPI. Não exige autenticação e não consulta banco nem fila.
Respostas
200Sucesso.
namestringobrigatórioO nome da API.docsstringobrigatórioO endereço da documentação legível.openapistringobrigatórioO endereço da especificação OpenAPI em JSON.