If you have the appropriate permissions, you can also retrieve VMs through infrastructure, either at the top level or per physical machine.
Cloud admins may need to use the switch enterprise feature because this request only returns VMs in the current enterprise
GET https://example.com/api/cloud/virtualmachines
Parameter | Type | Default Value | Description |
---|---|---|---|
vdc | String | Filter by virtual datacenter name | |
vapp | String | Filter by virtual appliance name | |
fqdn | String | Filter by virtual machine fqdn | |
vmname | String | Filter by virtual machine name | |
vmlabel | String | Filter by vmlabel | |
startwith | Integer | 0 | Number of the page to start from |
by | String | name | Ordering parameter, by default ordered by name |
has | String | Name filter | |
limit | Integer | 25 | Number of items to retrieve |
asc | Boolean | true | If the value of the 'by' parameter must be sorted in ascending order (true) or descending order (false) |
scalinggroupmaster | Boolean | If true, only return virtual machines with the master role in a scaling group | |
providerid | String | If present, filter by provider id. providerId If present, filter by provider id. Accepts single value and CSV. |