Docs

health

Liveness probe. Returns immediately with build information and uptime — no database, no auth.

Amfelt REST API · v1.13.0 · https://api.amfelt.com


GET /v1/health  

Process liveness.

Returns immediately with build version and the timestamp the process became ready. No database access, no authentication. Suitable for load-balancer liveness gates and management-console health probes.

Responses  

200 The process is alive.

application/json

PropertyTypeRequiredDescription
okbooleanYesAlways true when the endpoint returns 2xx. Examples: true.
Always true when the endpoint returns 2xx. Examples: true.
ready_sincestringYesTimestamp the api process became ready. Compare across polls to detect restarts.
Timestamp the api process became ready. Compare across polls to detect restarts.
versionstringYesBuild version of the running api process. Examples: 2.5.0.
Build version of the running api process. Examples: 2.5.0.

Schemas  

Health  

type: Health

Process liveness snapshot. Returned by GET /v1/health with no authentication and no database access.

PropertyTypeRequiredDescription
okbooleanYesAlways true when the endpoint returns 2xx. Examples: true.
Always true when the endpoint returns 2xx. Examples: true.
ready_sincestringYesTimestamp the api process became ready. Compare across polls to detect restarts.
Timestamp the api process became ready. Compare across polls to detect restarts.
versionstringYesBuild version of the running api process. Examples: 2.5.0.
Build version of the running api process. Examples: 2.5.0.

Last updated on October 31, 2026