Other

Get the appliance status

GET /status

Get Status

curl

curl -X GET "https://appliance.example.com/api/v1/status" \
  -H "Authorization: Bearer $TOKEN"

PHP

<?php

$url = 'https://appliance.example.com/api/v1/status';
$headers = [
    'Authorization: Bearer ' . $token,
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

Python

import requests

headers = {"Authorization": f"Bearer {token}"}

response = requests.get("https://appliance.example.com/api/v1/status", headers=headers)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://appliance.example.com/api/v1/status', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

const data = await response.json();

Response

{
  "status": "success",
  "message": "Status and Info",
  "data": {
    "lock": {
      "userId": "",
      "userLock": false,
      "transactionLocked": false,
      "transactionIgnoreError": true
    },
    "services": {
      "nodes": [
        {
          "id": "6fe-780-f3c-283",
          "services": [
            {
              "name": "nftables",
              "status": "active",
              "action": "",
              "messages": []
            },
            {
              "name": "gslb",
              "status": "inactive",
              "action": "",
              "messages": []
            },
            {
              "name": "haproxy",
              "status": "inactive",
              "action": "",
              "messages": []
            },
            {
              "name": "fallbackServer",
              "status": "inactive",
              "action": "",
              "messages": []
            },
            {
              "name": "pulseha",
              "status": "active",
              "action": "",
              "messages": []
            },
            {
              "name": "nginx",
              "status": "active",
              "action": "",
              "messages": []
            },
            {
              "name": "php",
              "status": "active",
              "action": "",
              "messages": []
            },
            {
              "name": "datetimechrony",
              "status": "active",
              "action": "",
              "messages": []
            },
            {
              "name": "ssh",
              "status": "active",
              "action": "",
              "messages": []
            },
            {
              "name": "rsyslog",
              "status": "inactive",
              "action": "",
              "messages": []
            },
            {
              "name": "dataServices",
              "status": "inactive",
              "action": "",
              "messages": []
            },
            {
              "name": "lb-websocket",
              "status": "active",
              "action": "",
              "messages": []
            },
            {
              "name": "logs",
              "status": "active",
              "action": "",
              "messages": []
            },
            {
              "name": "sidecar",
              "status": "inactive",
              "action": "",
              "messages": []
            },
            {
              "name": "systemStats",
              "status": "active",
              "action": "",
              "messages": []
            },
            {
              "name": "snmp",
              "status": "inactive",
              "action": "",
              "messages": []
            },
            {
              "name": "IPVSDirector",
              "status": "inactive",
              "action": "",
              "messages": []
            }
          ]
        }
      ]
    },
    "versions": {
      "nodes": [
        {
          "id": "6fe-780-f3c-283",
          "versions": {
            "release": "3.0.0-BETA",
            "api": "v1",
            "appliance": "9.9.0",
            "client": "9.7.0.2591"
          }
        }
      ]
    },
    "pulseha": {
      "status": "active",
      "message": "",
      "mode": "active-passive",
      "nodes": [
        {
          "id": "6fe-780-f3c-283",
          "hostname": "MC-LB-node-1",
          "ip": "10.200.0.121",
          "port": 9083,
          "lastResponse": "2025-09-22T21:48:41+01:00",
          "latency": "0ms",
          "status": "passive",
          "activeIPs": [],
          "groupAssignments": []
        }
      ]
    },
    "update": {
      "restartRequired": false,
      "majorVersion": [],
      "packages": [
        {
          "name": "lb_client",
          "summary": "Loadbalancer.org Angular Client Files",
          "description": "Package containing our Client for the loadbalancer",
          "url": "http://www.loadbalancer.org",
          "license": "GPLv2",
          "architecture": "noarch",
          "repository": "lbNightlyBuilds",
          "release": "4.el9",
          "currentVersion": "9.7.0.2591",
          "pendingVersion": "9.7.0.2592"
        }
      ],
      "onLineUpdates": true
    }
  }
}