Total Access Docs
Openapi

Platform health (Next.js + Database)

Checks database connectivity and platform maintenance mode. Supports `?platform=web|desktop|mobile` for platform-aware maintenance checks.

GET
/api/v1/health

Checks database connectivity and platform maintenance mode. Supports ?platform=web|desktop|mobile for platform-aware maintenance checks.

Query Parameters

platform?string

Platform context for maintenance mode awareness

Value in

  • "web"
  • "desktop"
  • "mobile"
  • "desktop_app"
  • "mobile_pwa"
  • "terminal_app"

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/health"
{  "status": "ok",  "database": true,  "timestamp": "2019-08-24T14:15:22Z"}
{  "status": "down",  "database": true,  "error": "string",  "timestamp": "2019-08-24T14:15:22Z"}

Aggregate health check GET

Checks all services in parallel and returns an aggregated status. Recommended endpoint for monitoring systems and status pages. No authentication required. Returns HTTP 200 regardless of individual service status — check the `status` field in the response.

Individual service health check GET

Probes a specific service's health endpoint and returns status. No authentication required.