Liveness + DB readiness
const url = 'https://beta-api.plune.ai/health';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://beta-api.plune.ai/healthReturns 200 when the app is up AND its database is reachable, else 503. Also reports the outbound-email state, which is informational and does not affect the status code.
Responses
Section titled “ Responses ”Up
object
Outbound sign-in email. armed — a provider is configured and the last send succeeded; failing — configured but the last send was rejected; log — no provider, links go to the server log. Informational only: it never changes the status code.
Who may open a NEW account. invite-only — an allowlist is configured and only the addresses on it (plus everyone who already has an account) can sign up; open — no list, anyone who can receive mail can. Informational, like email: it is here so that a deployment where the list failed to arrive can be told apart from one where it was never meant to.
Example
{ "status": "ok", "db": "up", "email": "armed", "door": "invite-only"}Degraded (DB unreachable)
object
Outbound sign-in email. armed — a provider is configured and the last send succeeded; failing — configured but the last send was rejected; log — no provider, links go to the server log. Informational only: it never changes the status code.
Who may open a NEW account. invite-only — an allowlist is configured and only the addresses on it (plus everyone who already has an account) can sign up; open — no list, anyone who can receive mail can. Informational, like email: it is here so that a deployment where the list failed to arrive can be told apart from one where it was never meant to.
Example
{ "status": "ok", "db": "up", "email": "armed", "door": "invite-only"}