vsmsconnect — API — health

← all endpoints

GET/health auth: none

Liveness probe. Returns `{ ok: true }` for a bare call. When `?services` is present (any value), the response also includes `services: { redis: boolean }` reflecting `Redis.testConnection()`. Unversioned (does NOT live under /api/v1).

handlers: Controllers.Health (platform/http/express/controllers/health.controller.ts)

Inputs

namerequireddefaultdescription
services query
string (presence only)
no—When present, the response includes a per-dependency boolean map. The value is ignored.

Outputs

200
{ ok: boolean; services?: Record<string, boolean> }
Bare JSON object — NOT wrapped in APIResponse.
500
APIError
Unexpected error from the dependency probe.