Path: / v310 / vm


Resources
NameDescription
deleteSyncDisksDelete all the virtual disks that restored via SyncVM File-Level Restore operation for each of the targeted virtual machine.
filterReturns VM properties as specified by a filter request such as performance stats minimum and maximum filter limits.
filterScopeReturns available filter properties.
policyErrorStatReturn a list of current policy errors, and the number of VMs affected by each type of error.
qosConfigUpdate multiple VM's QoS settings.
replicationConfigDeprecated. Create a new replication configuration for the specified VMs.
syncSynchronize a Virtual Machine to one of its snapshots.
thinProvisionConvert a collection of VMs and all their files to thin-provisioning for maximum space savings.
updateReplicationConfigToDefaultUpdate the outgoing replication configurations for the specified VMs to the system default replication configuration.
updateScheduleToDefaultUpdate selected VMs to use the default snapshot schedules.
vmListDownloadableCreate a URL for retrieving the specified VM list report which is returned as output.
{vmId}Return the virtual machine information specified in the URI.

Method Summary
ResourceDescription
GET /v310/vmReturn information on virtual machines in a pagenated form as specified by the request parameters.
POST /v310/vmCreates a clone of Virtual machine.

Method Detail
HTTP Example:
GET /v310/vm

API Example:

VirtualMachineResource.getVms({});

Description:
Return information on virtual machines in a pagenated form as specified by the request parameters.
Tintri Api Server Support:
All
Query parameter Reference:
VirtualMachineFilterSpec
Output:
Page - Paginated items representing VMs.
Errors:
Error CodeMessageHTTP Response Code
ERR-API-9026Get VM list failed500
Produces:
application/json;qs=1, application/xml;qs=0.5
Consumes:
application/json;qs=1, application/xml;qs=0.5
HTTP Example:
POST /v310/vm

API Example:

VirtualMachineResource.clone({'$entity': /* spec Specifies source VM/snapshot and clone destination properties for the clone operation. */});

Description:
Creates a clone of Virtual machine.
Tintri Api Server Support:
All
Input:
VirtualMachineCloneSpec - Specifies source VM/snapshot and clone destination properties for the clone operation.
Output:
Task - Task It is used to get the progress of the clone operation through Task APIs.
Errors:
Error CodeMessageHTTP Response Code
ERR-API-3003Failed to create remote clone configuration.500
ERR-API-3205Invalid clone request.400
ERR-API-3206Clone request failed.500
ERR-API-3213Clone workflow task failed.500
ERR-API-3214Resource not found for clone request.404
Produces:
application/json;qs=1, application/xml;qs=0.5
Consumes:
application/json;qs=1, application/xml;qs=0.5