Skip to main content
GET
/
status
Get Status
curl --request GET \
  --url https://pbx-{proxyboxId}.pbxz.io/api/v1/status \
  --header 'X-API-Key: <api-key>'
{
  "status": "<string>",
  "statusCode": 123,
  "result": {
    "module": "<string>",
    "message": "<string>",
    "content": {
      "uptime": 123,
      "version": "<string>",
      "load": 123,
      "totalMemory": 123,
      "freeMemory": 123,
      "ipAddress": "<string>",
      "buildVersion": "<string>",
      "builtAt": "<string>",
      "hostname": "<string>",
      "domain": "<string>",
      "extensions": [
        {
          "name": "<string>",
          "instances": [
            {
              "id": 123,
              "active": true,
              "os": "<string>",
              "daemon_version": "<string>",
              "cli_version": "<string>",
              "management": "<string>",
              "signal": "<string>",
              "relays": "<string>",
              "nameservers": "<string>",
              "fqdn": "<string>",
              "netbird_ip": "<string>",
              "interface_type": "<string>",
              "quantum_resistance": "<string>",
              "lazy_connection": "<string>",
              "networks": "<string>",
              "forwarding_rules": "<string>",
              "peers_count": "<string>"
            }
          ]
        }
      ]
    }
  }
}

Authorizations

X-API-Key
string
header
required

Response

Status Response

status
string
required
Example:

"success"

statusCode
integer
required

Standard HTTP status codes.

Example:

200

result
object
required