API v1
v1
View as Markdown

Check status

GET /api/v1/status no token

Tells you whether the instance is up and which release it runs. No token needed, so you can point a monitor at it.

This endpoint also answers QUERY, with the same parameters sent in the request body. How QUERY works.

Returns

The state of the instance, or a 503 status when something it depends on is unreachable.

status string

Always ok in this answer. An instance that cannot reach its database answers 503 instead, carrying status of error and nothing else, and one that is not running answers nothing at all. Those three are what a monitor watches for.

version string

The release the instance runs, as a semantic version such as 3.0.0. It is how a caller can tell whether a capability it needs has landed here yet.

instance string

The host answering, so a monitor watching several self hosted instances can tell them apart.

Rate limit

Sixty requests per minute, per address. Every answer carries the budget left in X-RateLimit-Remaining.

GET
curl https://my.monicahq.com/api/v1/status
const response = await fetch('https://my.monicahq.com/api/v1/status')
const data = await response.json()
$response = Http::get('https://my.monicahq.com/api/v1/status');
Response 200
{
"status": "ok",
"version": "3.0.0",
"instance": "app.monicahq.com"
}

Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.