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

GetOverview

Retrieve high-level platform overview including VM, host, and cluster counts

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • platformUuidString

    UUID of the platform to retrieve overview for UUID of the platform to retrieve overview for

Responses

200 OK

On success, this API returns the following response structure.

  • totalVmsString

    Total number of virtual machines across all clusters

    Example: 500

  • runningVmsString

    Number of currently running virtual machines

    Example: 480

  • stoppedVmsString

    Number of stopped virtual machines

    Example: 20

  • totalHostsString

    Total number of physical hosts

    Example: 32

  • onlineHostsString

    Number of online physical hosts

    Example: 31

  • totalImagesString

    Total number of registered images

    Example: 50

  • clustersList

    Clusters for this resource

    Example: (nested array)

    • uuidString

      Unique identifier of the cluster

      Example: cluster-abc-001

    • nameString

      Display name of the cluster

      Example: Production Cluster

    • vmCountString

      Total number of virtual machines in the cluster

      Example: 128

    • hostCountString

      Total number of physical hosts in the cluster

      Example: 16

Endpoint

GET/api/v1/monitoring/overview

/api/v1/monitoring/overview

Operation ID

GetOverview

Permalink

Request Example

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

Response Example

200
{
  "totalVms": 500,
  "runningVms": 480,
  "stoppedVms": 20,
  "totalHosts": 32,
  "onlineHosts": 31,
  "totalImages": 50,
  "clusters": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history