API reference
Health
Public health check endpoint for application and database connectivity status.
Endpoint
GET https://api.nexgate.app/healthReturns application health and database connectivity status.
Note
This endpoint is public and safe for uptime checks. It does not expose credentials or user data.
Authentication
No authentication is required.
Example
curl https://api.nexgate.app/healthconst response = await fetch("https://api.nexgate.app/health");
const health = await response.json();
if (!response.ok) {
throw new Error(`NexGate health check failed: ${health.db}`);
}Success response
{
"status": "ok",
"db": "connected",
"ts": 1746789600000
}Database unavailable response
{
"status": "error",
"db": "disconnected",
"ts": 1746789600000
}| Status | When |
|---|---|
200 | Database connectivity check succeeds |
503 | Database connectivity check fails |
Tip
Pair this endpoint with /api/models in production smoke tests: health confirms database connectivity, while models confirms catalog availability.