Get all VM instances

This URL gets all the virtual machine instances.

GET /vmgroup/vms

Query Parameters:

Field Name	Description	Data Type	Mandatory
`vmgroupid`	VM group ID. If specified, it gets all the VMs that belong to the VM group.	number	No
`protected`	If set to `true`, it gets the protected VMs. If set to `false`, it gets unprotected VMs. If no value is specified, it gets both protected and unprotected VMs.	string	No
`clusterName`	Cluster name. Gets VMs that belong to the specified cluster	string	No
`controllerName`	Controller name. Gets VMs that belong to the specified Controller.	string	No
`agentType`	If set to `vm`, it gets the VMs on which the Probe is installed. If set to `sensor`, it gets the Sensor instances on which the Probe is installed.	string	No

Following fields are returned in the response.

Field Name	Description	Data Type
`success`	Indicates if the GET operation is successful. Value is set to `true` if the GET operation is successful. Value is set to `false` if the GET operation is not successful.	string
`msg`	Not applicable	Not applicable
`errMsg`	Not applicable	Not applicable
`domainName`	Not applicable	Not applicable
`data`	Not applicable	Not applicable

Request

Response

{
"success": true,
"msg": null, 
"errMsg": null, 
"domainName": null, 
"data": null
}