Health
| Method | Path | Auth | SDK |
|---|---|---|---|
GET | /api/v1/health | none | mailroom.health() |
POST | /api/v1/health | none | — |
curl https://mailroom.example.com/api/v1/health
{ "ok": true, "service": "mailroom", "sdk": "0.3.0" }
sdk is the SDK version the deployment was built with — useful for confirming which
build is live, and for spotting a client far ahead of or behind the server.
POST returns the same body; it exists so a monitor restricted to POST can use the
same URL.
What it does and does not prove
A 200 means the app is up and serving. It does not exercise the database, the
delivery provider, or your API key — a healthy /health with failing sends is
entirely possible.
To check that your credentials work, call it through the SDK (which sends the key
even though the endpoint ignores it) and then make one authenticated read, e.g.
GET /api/v1/templates. An auth failure there is the real signal.
Safe to poll from uptime monitors: no key, no rate-limit bucket, no side effects.