Skip to content

System Information

Get system running status and information.

Interface Information

  • Endpoint: GET /api/admin/system
  • Authentication: Required (admin permission)
  • Content-Type: application/json

Request Headers

ParameterDescription
AuthorizationBearer Token

Response Fields

Field NameTypeDescription
versionstringSystem version
nodeVersionstringNode.js version
environmentstringEnvironment: development/production
uptimenumberUptime (seconds)
memoryobjectMemory information
memory.usednumberUsed memory (MB)
memory.totalnumberTotal memory (MB)
databaseobjectDatabase information
database.statusstringConnection status
database.latencynumberQuery latency (ms)
redisobjectRedis information
redis.statusstringConnection status

Request Example

bash
curl http://localhost:3000/api/admin/system \
  -H "Authorization: Bearer your-jwt-token"

Response Example

json
{
  "success": true,
  "data": {
    "version": "2.0.0",
    "nodeVersion": "v22.21.1",
    "environment": "production",
    "uptime": 86400,
    "memory": {
      "used": 512,
      "total": 2048
    },
    "database": {
      "status": "connected",
      "latency": 5
    },
    "redis": {
      "status": "connected"
    }
  }
}

Error Responses

HTTP Status CodeDescription
401Not logged in or token invalid
403Insufficient permission (non-admin)
500Server error