Skip to main content
GET
/
existing-systems
Get Existing Systems collection
curl --request GET \
  --url https://api.example.com/existing-systems \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "href": "<string>",
    "type": "HOST",
    "platform_model": "<string>",
    "total_physical_cpus": "<string>",
    "cores_per_cpu": "<string>",
    "memory": "<string>",
    "total_logical_cpus": "<string>",
    "threads_per_core": "<string>",
    "cpu_speed": "<string>",
    "cpu_model": "<string>",
    "entity_type": "<string>",
    "entity_role_name": "<string>",
    "parent": "<string>",
    "children": "<string>",
    "os": "<string>",
    "os_version": "<string>",
    "os_patch_level": "<string>",
    "ip_address": "<string>",
    "mac_address": "<string>",
    "serial_number": "<string>",
    "hostId": "<string>",
    "control_environment": {
      "id": "<string>",
      "name": "<string>",
      "platform_category": "External Cloud",
      "href": "<string>",
      "icon": "<string>"
    },
    "infrastructure_group": {
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    },
    "cpu_benchmarks": [
      {
        "name": "<string>",
        "score_type": "<string>",
        "value": 123
      }
    ],
    "I/O_benchmarks": [
      {
        "name": "<string>",
        "score_type": "<string>",
        "value": 123
      }
    ],
    "size": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
name
string

Exact system name to match.

​
name_like
string

Case-insensitive substring match for system name; '%' matches zero or more chars.

​
type
enum<string>

Filter by system type.

Available options:
HOST,
GUEST
​
platform
string

Filter by platform (interpreted via control environment), e.g., 'vmware'.

​
platform_category
enum<string>

Filter by platform category.

Available options:
External Cloud,
Internal Virtual
​
control_environment
string

Filter by control environment name.

​
infrastructure_group
string

Filter by infrastructure group (cluster) name.

​
details
boolean
default:false

When true, include additional detail fields (e.g., manufacturer, os, benchmarks).

Response

Array of Existing Systems

​
id
string
required
​
name
string
required
​
href
string
required
​
type
enum<string>
required

System type

Available options:
HOST,
GUEST
​
platform_model
string

Host model or instance type (when available).

​
total_physical_cpus
string
​
cores_per_cpu
string
​
memory
string

Normalized total memory (MB).

​
total_logical_cpus
string
​
threads_per_core
string
​
cpu_speed
string

Normalized CPU speed (MHz).

​
cpu_model
string
​
entity_type
string
​
entity_role_name
string
​
parent
string

Parent host name for GUEST; "N/A" for HOST.

​
children
string

Number of child VMs for HOST; "N/A" for GUEST.

​
os
string
​
os_version
string
​
os_patch_level
string
​
ip_address
string
​
mac_address
string
​
serial_number
string
​
hostId
string
​
control_environment
object
​
infrastructure_group
object
​
cpu_benchmarks
object[]
​
I/O_benchmarks
object[]
​
size
string

Hidden element used internally for size sorting.