Skip to main content

Server diagnostic readiness

A server can be running while a required service is unavailable. Telemus separates process liveness, server readiness and optional app diagnostics.

EndpointMeaning
/healthPublic liveness check: HTTP 200 means the server can answer.
/readyPublic readiness summary: HTTP 200 means the required local server checks pass; otherwise HTTP 503.
/doctor or /health/detailProtected app diagnostics. Inspect the returned checks; HTTP 200 alone does not mean every check passed.

Protected endpoints require the normal authentication and license access. A missing or invalid sign-in can return HTTP 401. Missing required license access returns HTTP 402 license_required.

Reading readiness​

Use /health to check whether the process responds and /ready to check whether its required local services are ready. The readiness result includes a summary and checks for request handling, workspace availability, access and channels. A failed required check can return HTTP 503 while /health remains HTTP 200.

Readiness does not verify every disk operation, remote provider, network route or device. Check the relevant channel or connection status separately.

Missing app diagnostics​

A standalone relay can be ready without app diagnostics. HTTP 503 with doctor_unavailable means that no usable app report is available; it does not by itself mean the relay needs repair or restart. A report containing failed checks must be read even when its HTTP status is 200.

Recovery​

Inspect the failed check and correct the reported configuration, storage or service problem. Do not disable access controls or start a second service on the same port to bypass a readiness failure. For a managed deployment, ask the operator to use its approved recovery procedure.

A channel permission check that is pending or temporarily unavailable means no model or tool ran. Retry after service readiness returns. An actual license_required response needs license recovery instead.

The same endpoint meanings apply to native, Web and terminal clients. The Web Command Center and terminal /doctor retain their app-backed diagnostic views.