Skip to main content
ZStack
Monitoring & Collection/Monitoring Query & Overview

GetHostVMs

List all virtual machines currently running on a specific physical host

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

Operation ID

GetHostVMs

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • uuid
    StringRequired

    UUID of the physical host to list VMs for

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

    • uuid
      String

      Unique identifier of the virtual machine

      Example: vm-001-def

    • name
      String

      Display name of the virtual machine

      Example: app-server-03

    • state
      String

      Current operational state of the VM

      Example: running