edubridge learning management system
GET /api/v1/status

Get comprehensive system status including memory usage, CPU usage, and environment details

Responses

  • 200 application/json

    System status information

    Hide response attributes Show response attributes object
    • service string Required

      Service name

    • version string Required

      Service version

    • status string Required

      Current service status

      Values are running, stopped, starting, or stopping.

    • timestamp string Required

      Current timestamp

    • uptime string Required

      Application uptime

    • environment string Required

      Runtime environment

    • node_version string Required

      Node.js version

    • platform string Required

      Operating system platform

    • arch string Required

      System architecture

    • memory object Required

      Memory usage statistics

      Hide memory attributes Show memory attributes object
      • rss string Required

        Resident Set Size

      • heapTotal string Required

        Total heap size

      • heapUsed string Required

        Used heap size

      • external string Required

        External memory usage

      • arrayBuffers string Required

        Array buffers memory usage

    • cpu object Required

      CPU usage statistics

      Hide cpu attributes Show cpu attributes object
      • user number Required

        User CPU time in microseconds

      • system number Required

        System CPU time in microseconds
  • 400 application/json

    Default bad request error 400 response

    Hide response attributes Show response attributes object
    • message string Required

      Response message

    • error string Required
    • statusCode number Required
GET /api/v1/status 
curl \
 --request GET 'http://localhost:3500/api/v1/status'
Response examples (200) 
{
  "service": "Edubridge Learning Management System",
  "version": "1.0.0",
  "status": "running",
  "timestamp": "2025-09-25T10:30:00.000Z",
  "uptime": "2d 5h 30m 45s",
  "environment": "production",
  "node_version": "v18.17.0",
  "platform": "linux",
  "arch": "x64",
  "memory": {
    "rss": "45.23 MB",
    "heapTotal": "20.15 MB",
    "heapUsed": "15.67 MB",
    "external": "2.34 MB",
    "arrayBuffers": "1.23 MB"
  },
  "cpu": {
    "user": 123456,
    "system": 78910
  }
}
Response examples (400) 
{
  "message": "string",
  "error": "string",
  "statusCode": 42.0
}