Skip to main content

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"
}
FieldTypeDescription
statusstring"healthy" when the platform is fully operational
timestampstringISO 8601 server timestamp at time of check
buildstringDeployed build identifier

Response — 503 Service Unavailable

One or more dependencies are degraded.

{
"status": "degraded",
"timestamp": "2025-04-07T14:23:11.847Z",
"services": {
"database": "error"
}
}
FieldTypeDescription
statusstring"degraded" — platform is partially functional
services.databasestring"ok" or "error" — database connectivity
services.*stringAdditional 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.