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

GetTopologyTree

Return a recursive topology tree rooted at the specified resource

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • typeStringRequired

    Resource type to root the topology tree at (e.g. cluster, host)

  • uuidStringRequired

    UUID of the root resource

Responses

200 OK

On success, this API returns the following response structure.

  • uuidString

    Unique identifier of this topology node

    Example: cluster-001

  • nameString

    Display name of this topology node

    Example: Production Cluster

  • typeString

    Resource type of this node (e.g. cluster, host, vm)

    Example: cluster

  • stateString

    Current state of this topology node

    Example: online

  • childrenList

    Children for this resource

    Example: (nested array)

    • uuidString

      Unique identifier of this topology node

      Example: cluster-001

    • nameString

      Display name of this topology node

      Example: Production Cluster

    • typeString

      Resource type of this node (e.g. cluster, host, vm)

      Example: cluster

    • stateString

      Current state of this topology node

      Example: online

    • childrenList

      Children for this resource

      Example: (nested array)

Endpoint

GET/api/v1/monitoring/topology/tree/{type}/{uuid}

/api/v1/monitoring/topology/tree/{type}/{uuid}

Operation ID

GetTopologyTree

Permalink

Request Example

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

Response Example

200
{
  "uuid": "cluster-001",
  "name": "Production Cluster",
  "type": "cluster",
  "state": "online",
  "children": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history