GET
/
health
Error
A valid request URL is required to generate request examples
{
  "status": "ok",
  "uptime": 123,
  "discord": {
    "status": 123,
    "ping": 123,
    "guilds": 123
  },
  "memory": {},
  "system": {
    "platform": "<string>",
    "nodeVersion": "<string>"
  },
  "errors": {
    "lastHour": 123,
    "lastDay": 123
  },
  "restarts": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "reason": "<string>",
      "version": "<string>",
      "uptimeBefore": 123
    }
  ]
}

Headers

x-api-secret
string

Optional — include for extended diagnostics

Response

200 - application/json

Server health status

status
string
Example:

"ok"

uptime
number

Server uptime in seconds

discord
object

Discord connection info (auth only)

memory
object

Process memory usage (auth only)

system
object

System info (auth only)

errors
object

Error counts (auth only)

restarts
object[]

Recent restart history (auth only)