GET/gateway/health

Check overall service health

Reports the gateway's overall health as a traffic-light status covering the internal services behind it, with no sign-in required.

AccessNo sign-in required

This endpoint is public, so send no token: it is meant for uptime monitors, load balancers, and status pages that have no credentials of their own. It answers with ok and a traffic-light status. Green means every internal service is reachable. Orange means a non-critical service is down while the core guarantees still hold. Red means a critical service is down and value-moving actions cannot be processed safely, so a mint, burn, transfer, or deployment should not be attempted until it clears.

Results are cached for about 15 seconds, which means polling faster than that returns the same answer and puts no extra load on the services behind the gateway. For the per-service breakdown behind the traffic light, use GET /health.

A successful response does not mean healthy

This call always answers successfully. An outage shows up in the status fields, not as a failed request, so a monitor that checks only the HTTP status code will report the platform as fine through a red status. Alert on the value of status.

bash

curl "$SQRL_API/gateway/health"

const res = await fetch(`${process.env.SQRL_API}/gateway/health`);
const { ok, status } = await res.json();

rust

let res = client
    .get(format!("{}/gateway/health", api_base))
    .send()
    .await?;

Response200 OK

{
"ok": true,
"status": "green"
}

Was this page helpful?