Health endpoint
GET /api/health
Returns the current operational status of the Traceable platform. No authentication required.
Use this to check whether the platform is reachable before making dependent API calls, or to add a pre-flight check to your integration's startup sequence.
Response — 200 OK
{
"status": "healthy",
"timestamp": "2025-04-07T14:23:11.847Z",
"build": "2026.04.07.1"
}
| Field | Type | Description |
|---|---|---|
status | string | "healthy" when the platform is fully operational |
timestamp | string | ISO 8601 server timestamp at time of check |
build | string | Deployed build identifier |
Response — 503 Service Unavailable
One or more dependencies are degraded.
{
"status": "degraded",
"timestamp": "2025-04-07T14:23:11.847Z",
"services": {
"database": "error"
}
}
| Field | Type | Description |
|---|---|---|
status | string | "degraded" — platform is partially functional |
services.database | string | "ok" or "error" — database connectivity |
services.* | string | Additional service keys may appear as the platform adds more monitored dependencies. Treat any services.*: "error" value as a degradation signal regardless of the key name. |
A 503 does not necessarily mean all functionality is unavailable. Check status.traceable.digital for incident details.
Deep health check (internal only)
The platform also runs a deeper health check that verifies database and cache connectivity. This endpoint is restricted to internal monitoring (scheduled platform jobs) and requires authentication. It is not available to external developers and is not part of the public API. Use GET /api/health for your own liveness checks.