Health

GET /health

Returns server status and uptime. This endpoint is public — no authentication is required for the basic response. When a valid x-api-secret header is included, the response is extended with Discord connection details, memory usage, system info, error counts, and restart history. Authentication: None required for basic response. Provide x-api-secret for extended diagnostics.

Headers

x-api-secret

string

Optional. When provided and valid, the response includes extended diagnostic fields.

Response fields (public)

status

string

Always ok when the server is running.

uptime

number

Server process uptime in seconds.

Additional fields (authenticated only)

discord

object

Discord WebSocket connection info.

Show Discord fields

status

integer

WebSocket connection status code.

ping

integer

WebSocket heartbeat ping in milliseconds.

guilds

integer

Number of guilds the bot is connected to.

memory

object

Node.js process memory usage (from process.memoryUsage()).

system

object

System information.

Show System fields

platform

string

Operating system platform.

nodeVersion

string

Node.js version string.

cpuUsage

object

CPU usage from process.cpuUsage().

pool

object | null

PostgreSQL connection pool statistics.

redis

object

Redis connection statistics.

errors

object

Error counts from the database log.

Show Error fields

lastHour

integer | null

Errors in the past hour.

lastDay

integer | null

Errors in the past 24 hours.

restarts

array

Recent restart history (up to 20 entries).

Show Restart entry fields

timestamp

string

ISO 8601 timestamp of the restart.

reason

string

Reason for the restart.

version

string | null

Bot version at time of restart.

uptimeBefore

number | null

Process uptime in seconds before the restart.

Examples

Public (no auth)
Extended (with API key)

curl https://volvox.bot/api/v1/health

{
  "status": "ok",
  "uptime": 432000
}

curl -H "x-api-secret: YOUR_SECRET" \
  https://volvox.bot/api/v1/health

{
  "status": "ok",
  "uptime": 432000,
  "discord": {
    "status": 0,
    "ping": 42,
    "guilds": 12
  },
  "memory": {
    "rss": 104857600,
    "heapTotal": 52428800,
    "heapUsed": 38000000,
    "external": 2000000
  },
  "system": {
    "platform": "linux",
    "nodeVersion": "v22.0.0"
  },
  "errors": {
    "lastHour": 0,
    "lastDay": 2
  },
  "restarts": [
    {
      "timestamp": "2026-03-20T08:00:00.000Z",
      "reason": "deploy",
      "version": "1.4.2",
      "uptimeBefore": 172800
    }
  ]
}

Overview

Endpoints

GET /health

Headers

Response fields (public)

Additional fields (authenticated only)

Examples

Build docs developers (and LLMs) love

Overview

Endpoints

​GET /health

​Headers

​Response fields (public)

​Additional fields (authenticated only)

​Examples

Build docs developers (and LLMs) love

GET /health

Headers

Response fields (public)

Additional fields (authenticated only)

Examples