Health & config

Endpoint reference

Method	Route	Auth	Purpose
`GET`	`/health`	Public	Basic health check
`GET`	`/health/ready`	Public	Readiness probe (checks DynamoDB)
`GET`	`/app/config`	Public	App version config & maintenance mode
`GET`	`/`	Public	API docs index

GET /health

Returns a simple 200 OK if the server process is running. Does not check downstream dependencies.

{
  "status": "ok"
}

Use this for liveness probes in container orchestration (ECS, Kubernetes).

GET /health/ready

Performs a lightweight DynamoDB operation to confirm the database is reachable. Returns 200 on success or 503 Service Unavailable on failure.

Success (200)
Failure (503)

{
  "status": "ready"
}

{
  "status": "not_ready",
  "error": "DynamoDB connection failed"
}

Use this for readiness probes — your load balancer should only route traffic to instances that pass this check.

GET /app/config

Returns the current app configuration. The mobile client uses this on launch to determine whether to force-update or show a maintenance screen.

string

Minimum supported app version (semver). Clients below this version are force-updated.

string

URL to the App Store listing. Used by the force-update prompt.

boolean

When true, the client shows a maintenance screen and blocks all API calls.

{
  "minAppVersion": "1.2.0",
  "storeUrl": "https://apps.apple.com/app/sightscreen/id123456789",
  "maintenanceMode": false
}

These values are controlled by the environment variables MIN_APP_VERSION, STORE_URL, and MAINTENANCE_MODE. Changes take effect immediately without redeployment — just update the env vars and restart the service.

Overview

Endpoints

Endpoint reference

GET /health

GET /health/ready

GET /app/config

​Endpoint reference

​GET /health

​GET /health/ready

​GET /app/config

Endpoint reference

GET /health

GET /health/ready

GET /app/config