| Parameter Name | Description | Required |
| account | List resources by Account. Must be used with the domainId parameter. | false |
| accumulate | Accumulates the Instance metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics. | false |
| affinitygroupid | List Instances by affinity group | false |
| arch | CPU arch of the VM | false |
| autoscalevmgroupid | The ID of AutoScaling Instance Group | false |
| backupofferingid | List by the backup offering | false |
| clusterid | The cluster ID | false |
| details | Comma separated list of Instance details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details. | false |
| displayvm | List resources by display flag; only ROOT admin is eligible to pass this parameter | false |
| domainid | List only resources belonging to the domain specified | false |
| extensionid | The ID of the Orchestrator extension for the VM | false |
| forvirtualnetwork | List by Network type; true if need to list Instances using Virtual Network, false otherwise | false |
| gpuenabled | Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned. | false |
| groupid | The group ID | false |
| haenable | List by the High Availability offering; true if filtering Instances with HA enabled; false for Instances with HA disabled | false |
| hostid | The host ID | false |
| hypervisor | The target hypervisor for the Template | false |
| id | The ID of the Instance | false |
| ids | The IDs of the Instances, mutually exclusive with id | false |
| isoid | List Instances by ISO | false |
| isrecursive | Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. | false |
| isvnf | flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise. | false |
| keypair | List Instances by SSH keypair name | false |
| keyword | List by keyword | false |
| leased | Whether to return only leased instances | false |
| listall | If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. | false |
| name | Name of the Instance (a substring match is made against the parameter value, data for all matching Instances will be returned) | false |
| networkid | List by Network ID | false |
| page | | false |
| pagesize | | false |
| podid | The pod ID | false |
| projectid | List objects by project; if projectid=-1 lists All Instances | false |
| retrieveonlyresourcecount | Makes the API's response contains only the resource count | false |
| securitygroupid | The security group ID | false |
| serviceofferingid | List by the service offering | false |
| showicon | Flag to display the resource icon for Instances | false |
| state | State of the Instance. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed. | false |
| storageid | The storage ID where vm's volumes belong to | false |
| tags | List resources by tags (key/value pairs) | false |
| templateid | List Instances by Template | false |
| userdata | Whether to return the Instances' User data or not. By default, User data will not be returned. | false |
| userdataid | the instances by userdata | false |
| userid | The user ID that created the Instance and is under the Account that owns the Instance | false |
| vpcid | List Instances by VPC | false |
| zoneid | The availability zone ID | false |