Returns the Virtual Machines in a vCenter Server.

get

https://cluster.ip.address/irisservices/api/v1/public/protectionSources/virtualMachines

Privileges: PROTECTION_VIEW

Returns all Virtual Machines found in all the vCenter Servers registered
on the Cohesity Cluster that match the filter criteria specified using
parameters.
If an id is specified, only VMs found in the specified vCenter Server
are returned.
Only VM Objects are returned.
Other VMware Objects such as datacenters are not returned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

vCenterId

int64

Limit the VMs returned to the set of VMs found in a specific
vCenter Server.
Pass in the root Protection Source id for the vCenter Server
to search for VMs.

names

array of strings

Limit the returned VMs to those that exactly match the passed in VM name.
To match multiple VM names, specify multiple "names" parameters that each
specify a single VM name.
The string must exactly match the passed in VM name and wild cards are
not supported.

names

uuids

array of strings

Limit the returned VMs to those that exactly match the passed in UUIDs.

uuids

protected

boolean

Limit the returned VMs to those that have been protected
by a Protection Job.
By default, both protected and unprotected VMs are returned.

pruneNonCriticalInfo

boolean

Specifies whether to prune non-critical info within entities.
In case of VMs, virtual disk information will be pruned.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError