Server-side APIEndpointsOther

Health

Is the gateway up? The one route that needs no credentials.

GET /v1/health

A liveness check. No API key, no allowlist — it is the only route on this surface that answers an unauthenticated caller.

Try it

GET/v1/health

Public — succeeds even without a key.

Request
GET /v1/health
to https://api.medos.one
Use a dedicated test key, and put your browser's address on its allowlist

A Developer API key authenticates on its own, so it only works from the addresses registered against it — and this page calls from your browser, not your servers. Unless your own public address is on the list you get a 403 naming it, which is the allowlist doing its job. Your browser may also reach us over IPv6 even when your server does not, so the address in the error is often not the one you expected. The key here is kept in memory only and never written to storage, but create a test key for it and deactivate that key when you are done.

Request

curl -s "https://api.medos.one/v1/health"

Response

true

200 with the literal true. Anything else — a timeout, a 5xx, an HTML error page from a proxy in between — means the gateway is not serving.

What it does and does not tell you

It confirmsIt does not confirm
The gateway is reachable from where you areThat your API key is valid
DNS, TLS and any proxy in front of it are fineThat your address is on the allowlist
That the Medos core behind it is healthy

Use it to isolate a credential problem

When a call fails and you cannot tell whether the problem is yours or ours, call this first. A 200 here with a 401 everywhere else puts the problem squarely in how your tokens are built — work through Errors.

Because it is unauthenticated, it is also the wrong thing to point a monitor at if what you actually want to know is whether your integration still works. For that, call workspace detail with your API key — it exercises the key, the allowlist and an upstream read in one request.

On this page