Skip to main content
GET
/
health
curl -X GET https://oro-tradebook-devnet.up.railway.app/health

{
  "status": "healthy",
  "timestamp": "2024-01-15T10:30:00.000Z",
  "database": {
    "status": "healthy",
    "responseTime": 5,
    "timestamp": "2024-01-15T10:30:00.000Z"
  },
  "environment": "development",
  "version": "1.0.0"
}

​
Overview

Returns comprehensive system health information including database connectivity and environment details. This endpoint is public - no authentication required.

​
Response

​
status
string
Overall system status: healthy or unhealthy
​
timestamp
string
ISO timestamp of the health check
​
database
object
​
environment
string
Current environment (development/staging/production)
​
version
string
API version

​
Response Codes

  • 200: Server is healthy
  • 503: Server is unhealthy (database issues or other problems)
curl -X GET https://oro-tradebook-devnet.up.railway.app/health

{
  "status": "healthy",
  "timestamp": "2024-01-15T10:30:00.000Z",
  "database": {
    "status": "healthy",
    "responseTime": 5,
    "timestamp": "2024-01-15T10:30:00.000Z"
  },
  "environment": "development",
  "version": "1.0.0"
}