Skip to main content
GET
/
systems
Get Collection
curl --request GET \
  --url https://{host}/systems \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "5da2be9c-3915-46df-a127-387e837a0697",
    "name": "esx-test-274",
    "href": "/systems/5da2be9c-3915-46df-a127-387e837a0697",
    "resource_id": "esx-test-274",
    "type": "classic_vm",
    "platform_model": "standard_a0",
    "platform": "AZURE",
    "total_physical_cpus": "1",
    "cores_per_cpu": "1",
    "memory": "768",
    "infrastructure_group": {
      "id": "c55e12ae-d568-427b-997d-1d5c54065a2d",
      "name": "eastus-test-vm",
      "href": "/infrastructure-groups/c55e12ae-d568-427b-997d-1d5c54065a2d"
    },
    "control_environment": {
      "id": "da70ab94-cea1-4a8a-83d7-c26a675ce650",
      "name": "cc377154-9605-4cb0-8b41-1b39e1c4ac0f",
      "platform_category": "External Cloud",
      "href": "/control-environments/da70ab94-cea1-4a8a-83d7-c26a675ce650",
      "icon": "/control-environments/da70ab94-cea1-4a8a-83d7-c26a675ce650/icon"
    },
    "attributes": [
      {
        "id": "attr_azure_resource_group",
        "name": "Resource Group",
        "value": "test-vm"
      },
      {
        "id": "attr_azure_tenant_id",
        "name": "Tenant ID",
        "value": "6c9190a7-bca6-4fcd-b35e-36378aadc695"
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer
default:0

Zero-based page index (page=0 is the first page)

Required range: x >= 0
​
page_size
integer
default:25

Page size when paging is enabled

Required range: 1 <= x <= 500
​
details
boolean
default:false

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

​
sort_by
string

Sort the collection.

Supported:

  • size (primary: memory; secondary: total_physical_cpus; tertiary: cores_per_cpu)
  • name

Add ,desc for descending order (default ascending). Examples: size,desc, name.

​
attributes_mode
enum<string>
default:On

Show (On) or hide (Off) set attributes for each system. Ignored if any attribute filter is used.

Available options:
On,
Off
​
setdisplay_category
string

Comma-separated list of attribute categories to return (e.g., Business,Transformation,Public Cloud).

​
name
string

Exact match on system name

​
name_like
string

Case-insensitive substring match. Use % to match zero or more chars (e.g., %test%).

​
resource_id
string

Cloud/provider system ID

​
type
enum<string>

Filter by system type

Available options:
host,
guest,
vm,
arm_vm,
classic_vm,
rds,
asg,
ecs_svc
​
platform
string

Filter by platform; supports multiple values (comma-separated). Supported: vmware, hmc, aws, gcp, azure, containers

​
infrastructure_group
string

Filter by infrastructure group (cluster) name

​
control_environment
string

Filter by control environment name

​
platform_category
enum<string>

Filter by control environment category

Available options:
External Cloud,
Internal Virtual
​
attribute_name_like
string

Returns systems having attributes whose names contain the given substring (supports % wildcard).

​
attribute_id
string

Comma-separated attribute IDs (logical OR)

​
attribute_name
string

Comma-separated attribute names (logical OR). URL-encode spaces as +.

​
attribute_id_value
string

Semicolon-separated ID,value pairs (logical AND across pairs).

​
attribute_name_value
string

Semicolon-separated name,value pairs (logical AND across pairs).

Response

Collection of systems

​
id
string
required

Densify 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[]