LunaDocs

Loading search...

PortuguêsSign in to the console
On this page

Status

Use with AI

Availability probes and the state of the platform. No authentication.

Check whether the API is up

GET/healthz

Answers 200 while the process is running. It requires no authentication and touches neither database nor queue, because it probes the process and not its dependencies. A 200 here does not promise that message sending works.

Authentication
Public, no key

Responses

200Success.

See whether Luna is receiving and delivering

GET/status

Answers 200 with the platform state, measured every few minutes by a synthetic message that enters through the same door Meta uses and has to reach a destination over HTTPS. It requires no authentication and reveals no account data. When there is no recent check yet, the state is unknown, never ok.

Authentication
Public, no key

Responses

200Success.
  • statusstringrequired
    O 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.Values: ok degraded down unknown
  • checkedAtstring | nullrequired
    Quando a última verificação terminou, em UTC. Nulo se nunca houve.
  • componentsobjectrequired
    Cada parte do caminho, medida de ponta a ponta por uma mensagem sintética.
  • components.ingestionstringrequired
    A porta que recebe os webhooks da Meta.Values: ok degraded down unknown
  • components.deliverystringrequired
    A entrega de um evento recebido ao destino, por HTTPS.Values: ok degraded down unknown
  • components.partitionsstringrequired
    O horizonte de partições futuras do banco.Values: ok degraded down unknown
  • sincestring | nullrequired
    Desde quando o veredito geral é o atual, em UTC. Nulo se unknown.

Introduce the API

GET/

Answers 200 with the API name and the addresses of the documentation and of the OpenAPI specification. It requires no authentication and touches neither database nor queue.

Authentication
Public, no key

Responses

200Success.
  • namestringrequired
    O nome da API.
  • docsstringrequired
    O endereço da documentação legível.
  • openapistringrequired
    O endereço da especificação OpenAPI em JSON.