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": "ok",
"build": "traceable-ops-verified-2026-02-28",
"timestamp": "2025-04-07T14:23:11.847Z"
}
| Field | Type | Description |
|---|---|---|
status | string | "ok" when the platform is responding |
timestamp | string | ISO 8601 server timestamp at time of check |
build | string | A fixed build marker. It is not a version number and does not change from release to release |
commit | string | The full SHA of the deployed commit. Present only when the request carries Authorization: Bearer <token> with the platform's build-info token; without it the field is absent. Traceable's own deploy checks use it, and integrations do not need it |
If the endpoint does not return 200
GET /api/health is a static liveness check. It does not query the database or the cache, and it does not report on individual services. A response other than 200, or no response, means the platform is unreachable or failing. Retry with exponential backoff, and 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.