Skip to main content
GET
/
system
/
{system_name}
Get a system
curl --request GET \
  --url https://api.example.com/system/{system_name} \
  --header 'Authorization: Bearer <token>'
{
  "name": "<string>",
  "status": "<string>",
  "location": "<string>",
  "nodes": [
    {
      "id": 123,
      "address": "<string>",
      "system_name": "<string>",
      "role": "active",
      "location": "<string>",
      "description": "<string>",
      "type": "nsos-v",
      "version": "<string>",
      "build_number": 123,
      "build_sha": "<string>",
      "iso_epoch": 123,
      "vendor": "<string>",
      "model": "<string>",
      "serial": "<string>",
      "virtual": true,
      "cpu_type": "<string>",
      "cpu_isolated": "<string>",
      "cpu_socket_count": 123,
      "cpu_core_per_socket": 123,
      "cpu_cores_total": 123,
      "mem_total": 123,
      "disk_total": 123,
      "health_score": 123,
      "last_role_change": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "status": "registered",
      "availability": "up",
      "ha_status": "auto"
    }
  ],
  "active_node": "<string>",
  "wg_conf": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

Response

Successful Response

name
string
required
status
string
required
location
string
required
nodes
Node · object[]
required
active_node
string | null
wg_conf
Wg Conf · object