Health

Service health check

Returns service status, uptime, version, and dependency status (PostgreSQL).

get/health

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /health
  • Auth: none declared

Response

Service is running correctly

status'UP' | 'DOWN' required

Overall service status

timestampnumber double required

Unix timestamp

uptime_secondsinteger required

Service uptime in seconds

versionstring

Application version (e.g. from VERSION env variable)

dependenciesobject required

Dependency status (e.g. postgres)

Changes

No recorded changes to this operation across all 1 revision of this API.