Skip to content

health

Health check and system status

Operations

Health check

Request

Health check endpoint that returns the application status, uptime, and version information.

This endpoint is used by load balancers and monitoring systems.

Note: This endpoint does not require authentication.

Security
Bearer
GET
/health
curl -i -X GET \
  https://data.logmycare.co.uk/openapi/health \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Application is healthy

Bodyapplication/json
statusstring
Enum:"ok""error"
Example:"ok"
timestampstring, (date-time)
Example:"2024-09-10T10:30:00.000Z"
uptimenumber

Application uptime in milliseconds

Example:3600000
versionstring

Application version from package.json

Example:"1.0.0"
commitShastring

Git commit SHA the running build was built from

Example:"9f8e7d6a1b2c3d4e5f60718293a4b5c6d7e8f901"
databaseSourcestring

Active database source implementation

Value:"mongo"
Example:"mongo"
Response
{
  "status": "ok",
  "timestamp": "2024-09-10T10:30:00.000Z",
  "uptime": 3600000,
  "version": "1.0.0",
  "commitSha": "9f8e7d6a1b2c3d4e5f60718293a4b5c6d7e8f901",
  "databaseSource": "mongo"
}