Skip to main content
GET
/
systems
/
{id}
Get Individual System
curl --request GET \
  --url https://{host}/systems/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://{host}/systems/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{host}/systems/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/systems/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://{host}/systems/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://{host}/systems/{id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{host}/systems/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "name": "<string>",
  "href": "<string>",
  "resource_id": "<string>",
  "platform_model": "<string>",
  "total_physical_cpus": "<string>",
  "total_logical_cpus": "<string>",
  "cores_per_cpu": "<string>",
  "threads_per_core": "<string>",
  "memory": "<string>",
  "parent": "<string>",
  "children": "<string>",
  "manufacturer": "<string>",
  "os": "<string>",
  "os_patch_level": "<string>",
  "os_version": "<string>",
  "ip_address": "<string>",
  "mac_address": "<string>",
  "entity_role_name": "<string>",
  "entity_type": "<string>",
  "control_environment": {
    "id": "<string>",
    "name": "<string>",
    "href": "<string>",
    "icon": "<string>"
  },
  "infrastructure_group": {
    "id": "<string>",
    "name": "<string>",
    "href": "<string>"
  },
  "cpu_benchmarks": [
    {
      "value": 123
    }
  ],
  "I/O_benchmarks": [
    {
      "value": 123
    }
  ],
  "attributes": [
    {
      "id": "<string>",
      "name": "<string>",
      "value": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Kubex unique system ID

Query Parameters

details
boolean
default:false

Include extra details for applicable elements (e.g., children, manufacturer, os)

Response

System

A discovered system

id
string
required

Kubex unique system ID

name
string
required
href
string
required
resource_id
string

Cloud/provider unique ID (when applicable)

type
enum<string>

System type

Available options:
host,
guest,
vm,
arm_vm,
classic_vm,
rds,
asg,
ecs_svc
platform
enum<string>

System platform

Available options:
VMWARE,
HMC,
AWS,
GCP,
AZURE,
CONTAINERS
platform_model
string

Host model (hosts) or instance type (cloud instances)

total_physical_cpus
string

Secondary sort key for sort_by=size

total_logical_cpus
string
cores_per_cpu
string

Tertiary sort key for sort_by=size

threads_per_core
string
memory
string

Normalized total memory (MB). Primary sort key within size

parent
string

Parent host name for VMs; "N/A" for hosts

children
string

Number of child systems (returned when details=true and applicable)

manufacturer
string

Returned when details=true

os
string

Returned when details=true

os_patch_level
string
os_version
string
ip_address
string
mac_address
string
entity_role_name
string

Role derived from platform/role (e.g., VMWARE_VM)

entity_type
string

Entity type derived from platform/system type

control_environment
object
infrastructure_group
object
cpu_benchmarks
object[]
I/O_benchmarks
object[]
attributes
object[]