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

GetVMHierarchy

Get the full resource hierarchy for a virtual machine (VM → host → cluster → zone)

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 virtual machine to retrieve hierarchy for

Responses

200 OK

On success, this API returns the following response structure.

  • vmObject

    The vm value

    • uuidString

      Unique identifier of the resource

      Example: res-abc-001

    • nameString

      Display name of the resource

      Example: primary-host-01

    • stateString

      Current state of the resource (e.g. running, stopped, error)

      Example: running

    • typeString

      Resource type (e.g. vm, host, cluster, zone)

      Example: host

  • hostObject

    The host value

    • uuidString

      Unique identifier of the resource

      Example: res-abc-001

    • nameString

      Display name of the resource

      Example: primary-host-01

    • stateString

      Current state of the resource (e.g. running, stopped, error)

      Example: running

    • typeString

      Resource type (e.g. vm, host, cluster, zone)

      Example: host

  • clusterObject

    Cluster for this resource

    • uuidString

      Unique identifier of the resource

      Example: res-abc-001

    • nameString

      Display name of the resource

      Example: primary-host-01

    • stateString

      Current state of the resource (e.g. running, stopped, error)

      Example: running

    • typeString

      Resource type (e.g. vm, host, cluster, zone)

      Example: host

  • zoneObject

    The zone value

    • uuidString

      Unique identifier of the resource

      Example: res-abc-001

    • nameString

      Display name of the resource

      Example: primary-host-01

    • stateString

      Current state of the resource (e.g. running, stopped, error)

      Example: running

    • typeString

      Resource type (e.g. vm, host, cluster, zone)

      Example: host

Endpoint

GET/api/v1/monitoring/topology/vm/{uuid}/hierarchy

/api/v1/monitoring/topology/vm/{uuid}/hierarchy

Operation ID

GetVMHierarchy

Permalink

Request Example

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

Response Example

200
{
  "vm": {},
  "host": {},
  "cluster": {},
  "zone": {}
}

Change History

This API has no change history records yet.

View all change history