Health

API information

Public API info endpoint that returns:

  • Application version (from mix.exs)
  • Database connectivity status (SELECT 1 query in separate process)
  • Current timestamp

Database check: Creates a separate Repo process to test connectivity, which handles password rotation gracefully by establishing a fresh connection.

No authentication required.

get/api/info

Request

  • Base URL: http://localhost:4100
  • URL: http://localhost:4100/api/info
  • Auth: none required

Response

API is healthy

database_status'connected' | 'disconnected' required
status'ok' | 'error' required
timestampstring date-time required
versionstring required

Example response

{
  "database_status": "connected",
  "status": "ok",
  "timestamp": "2026-02-04T12:34:56.789Z",
  "version": "0.1.0"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.