Skip to main content

Get all VMs (Deprecated)​

Select

SaaS
Customer Managed

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

This operation returns all the VMs.

More Details

Query Parameters
  • status int32

    Possible values: [All, Protected, Not Protected, Pending, Backed up with error, Discovered]

    VM Status to filter

Header Parameters
  • PagingInfo string required

    a,b such that a represent page number and b represent number of records

Responses

OK

Schema
  • totalRecords integer
  • pageNo integer
  • errorMessage string
  • errorCode integer
  • pageSize integer
  • vmStatusInfoList object[]
  • vmHost string
  • vmGuestSpace integer
  • bkpStartTime integer
  • type integer
  • vmStatus integer
  • vmBackupJob integer
  • strOSName string
  • isDeleted boolean
  • vendor integer
  • osType integer
  • vmSize integer
  • vmUsedSpace integer
  • subclientId integer
  • bkpEndTime integer
  • vmAgent string
  • name string
  • vmHardwareVer string
  • strGUID string
  • subclientName string
  • client object
  • clientId integer
  • clientName string
  • proxyClient object
  • clientId integer
  • clientName string
  • plan object
  • pseudoClient object
  • clientId integer
  • clientName string
  • flags object
  • disabled boolean
  • vmSubClientEntity object
  • subclientId integer
  • subclientName string
GET /vm

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
PagingInfo — header required
status — query
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/VM' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'