Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Monitoring Query & Overview
GETMonitoringSince 1.0SynchronousAuth Required

GetHostVMs

List all virtual machines currently running on a specific physical host

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    UUID of the physical host to list VMs for

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • uuidString

      Unique identifier of the virtual machine

      Example: vm-001-def

    • nameString

      Display name of the virtual machine

      Example: app-server-03

    • stateString

      Current operational state of the VM

      Example: running

Endpoint

GET/api/v1/monitoring/topology/host/{uuid}/vms

/api/v1/monitoring/topology/host/{uuid}/vms

Operation ID

GetHostVMs

Permalink

Request Example

curl -X GET '{host}/api/v1/monitoring/topology/host/{uuid}/vms' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history