DEVELOPER DOCUMENTATION

GET /health

Health check endpoint. Returns service status.

Start in Observe on one route. Use the deployment URL and installed package version supplied for your workspace. Historical host examples and source capabilities do not establish a live service or published release.

Endpoint

Code
GET https://gate.x-lock.dev/health

Description

Returns the current health status of the MANDATE gate service. Use this for

monitoring and uptime checks. When the deployment requires backing

dependencies (Postgres, Redis outside explicit local development), the check

verifies them and returns 503 if any are unreachable. The dependency result

is reused for up to one second, so a lost dependency is reported within a few

seconds. Polling faster than about twice a second from one address may return

429; that means slow down, not that the service is unhealthy.

Response

Content-Type: application/json

json
{
  "status": "ok"
}

status

Service status. Returns "ok" when the service is healthy, "unavailable"

when a required dependency check fails.

Status Codes

StatusMeaning
200Service is healthy
429Polled too often from one address; retry later
503Service is degraded or unavailable

Usage

bash
curl https://gate.x-lock.dev/health

Tip

For monitoring, poll this endpoint from your uptime checker. A public status

page is planned; check the MANDATE dashboard for current service notices.