GET /status

Returns the current status of your ProxyBox device including uptime, version, memory, and active extensions.

Endpoint:

GET /api/v1/status

Response

{
  "status": "success",
  "statusCode": 200,
  "result": {
    "module": "/status",
    "message": "Successfully obtained device status.",
    "content": {
      "uptime": 109975.16,
      "version": "3.2.1",
      "load": 0,
      "totalMemory": 1936011264,
      "freeMemory": 1559552000,
      "ipAddress": "192.168.86.31",
      "buildVersion": "3.2.1",
      "builtAt": "2025-01-15",
      "hostname": "pbx-JRDN",
      "domain": "pbxz.io",
      "extensions": []
    }
  }
}

Response Fields

Field	Type	Description
`uptime`	`number`	Device uptime in seconds.
`version`	`string`	Software version.
`load`	`number`	Current CPU load average.
`totalMemory`	`number`	Total RAM in bytes.
`freeMemory`	`number`	Available RAM in bytes.
`ipAddress`	`string`	Device’s local IP address.
`buildVersion`	`string`	Build version identifier.
`builtAt`	`string`	Build date (`YYYY-MM-DD`).
`hostname`	`string`	Device hostname (e.g. `pbx-JRDN`).
`domain`	`string`	Domain suffix.
`extensions`	`array`	Status objects for each active extension (Reverse Proxy, External App, IFS Print Agent, Netbird).