List Machines Using GET

This API supports Pagination and Filters.
For Pagination, optional query params of 'page' and 'size' need to be sent.
For Filters, refer to 'MachineInfo' model description to find supported filters on specific field.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.com

Request

URI

GET

https://{api_host}//localhost/rest/inventory/v1/machines

COPY

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

[
    {
        "agent_build_number": 22673015,
        "agent_version": 7.12,
        "attempted_theft_by_connection_server": [
            "string"
        ],
        "configured_by_connection_server": [
            "string"
        ],
        "desktop_pool_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
        "dns_name": "machine1.example.com",
        "id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
        "managed_machine_data": {
            "clone_error_message": "Timeout expired trying to clone a virtual machine.",
            "clone_error_time": 1575285661395,
            "create_time": 1575285661395,
            "host_name": "WD332H5",
            "in_hold_customization": false,
            "in_maintenance_mode": false,
            "memory_mb": 1024,
            "missing_in_vcenter": false,
            "network_labels": [
                {
                    "network_label_name": "example-network",
                    "nic_name": "network1"
                }
            ],
            "path": "/path/host",
            "storage_accelerator_state": "CURRENT",
            "virtual_center_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
            "virtual_disks": [
                {
                    "capacity_mb": 102400,
                    "datastore_path": "datastore1",
                    "path": "/path/host"
                }
            ],
            "virtual_machine_power_state": "POWERED_ON"
        },
        "message_security_enhanced_mode_supported": true,
        "message_security_mode": "MIXED",
        "name": "machine1",
        "operating_system": "WINDOWS_SERVER_2016",
        "operating_system_architecture": "BIT_64",
        "pairing_state": "IN_PAIRING",
        "remote_experience_agent_build_number": 32573985,
        "remote_experience_agent_version": 7.12,
        "state": "PROVISIONING",
        "type": "MANAGED_MACHINE",
        "user_ids": [
            "S-1-1-1-3965912346-1012345398-3123456564-123",
            "S-1-2-3-3123456786-1012345398-3123456784-124"
        ]
    }
]

400

Bad Request

Operation doesn't return any data structure

401

User is not authenticated

Operation doesn't return any data structure

On This Page

Description

Request

Authentication

Response

200 Response Body

Errors

Inventory Operations