| GET |
/info |
Returns basic information about API supported by this server. |
All | | RestApi - RestApi Contains information about API versions supported and preferred version on this server. |
| GET |
/v310/alert |
Fetches information based on the alert related query string parameters. |
All | | Page - Paginated items. |
| PUT |
/v310/alert |
Updates the specified properties by values of passed alerts instance. |
All | Request<Alert> - Container of Alert | void |
| POST |
/v310/alert/alertListDownloadable |
Create a URL for retrieving the specified alert report which is returned as output. |
TgcOnly | AlertDownloadableReportFilter - The filer for generating the report. | String - The URL that the user can use to retrieve the alert list report. |
| GET |
/v310/alert/filter |
Returns alert properties as specified by a filter request such as VMstore names and log message count. |
TgcOnly | | FilterScope - FilterScope |
| PUT |
/v310/alert/markArchived |
Marks all non-archived alerts to archived. |
All | | void |
| PUT |
/v310/alert/markRead |
Marks all non-acknowledged alerts to acknowledged. |
All | | void |
| POST |
/v310/alert/notificationPolicy |
Create a new notification policy. |
All - Since v310.66 | NotificationPolicy - the notification policy to be added to the vmstore. | NotificationPolicy - the newly created notification policy. |
| GET |
/v310/alert/notificationPolicy |
Get all notification policies or get notification policies filtered by the corresponding alert ID. |
All - Since v310.66 | | List<NotificationPolicy> - List of |
| GET |
/v310/alert/notificationPolicy/allowedUserAlertIds |
Returns a sorted list of user alert ID that allowed for Alert Notification Policy. |
All - Since v310.141 | | List<String> - |
| PUT |
/v310/alert/notificationPolicy/{uuid} |
Update an existing notification policy. |
All - Since v310.66 | NotificationPolicy - the notification policy to be updated | NotificationPolicy - the updated notification policy. |
| DELETE |
/v310/alert/notificationPolicy/{uuid} |
Delete the notification policy associated with the specified ID. |
All - Since v310.66 | | void |
| GET |
/v310/alert/notificationPolicy/{uuid} |
Get the notification policy associated with the specified ID. |
All - Since v310.66 | | NotificationPolicy - |
| GET |
/v310/appliance |
Gets Tintri Appliances. |
All | | List<Appliance> - List of Appliance instances. |
| GET |
/v310/appliance/authProvider |
Returns the current Identity Providers configurations. |
All - Since v310.151 | | AuthProvider - |
| DELETE |
/v310/appliance/authProvider |
Delete the Auth Provider. |
All - Since v310.151 | | void |
| POST |
/v310/appliance/authProvider |
Create the Authentication Provider which contains the OAuth 2 configurations used to SSO authenticate the user. |
All - Since v310.151 | AuthProvider | AuthProvider - |
| PUT |
/v310/appliance/authProvider |
Update the Auth Provider. |
All - Since v310.151 | AuthProvider | AuthProvider - |
| GET |
/v310/appliance/{uuid} |
Gets Tintri Appliance properties. |
All | | List<Appliance> - List of Appliance instances |
| PUT |
/v310/appliance/{uuid} |
Updates Tintri appliance's specified properties. |
All | Request<Appliance> - The request contains properties to update | void |
| POST |
/v310/appliance/{uuid}/action=testEmail |
Deprecated. Tests alert mail. |
All | ApplianceEmail | Response - The response to indicate if the test email is successful or not |
| POST |
/v310/appliance/{uuid}/action=testSNMP |
Deprecated. Send a SNMP test trap to a remote trap receiver host. |
VMstoreOnly - Since v310.41 | Request<ApplianceSnmp> - This contains the user security and remote host information. | Response - Formatted error message if operation fails. |
| POST |
/v310/appliance/{uuid}/action=testSyslogForwarding |
Deprecated. Send a test log forwarding message to the remote host. |
VMstoreOnly | Request<ApplianceSyslogForwarding> - This contains the remote host address. | Response - Formatted error message if operation fails. |
| POST |
/v310/appliance/{uuid}/action=upgrade |
Deprecated. Starts the Tintri appliance upgrade. |
All | | Response - The respond to indicate if request is successful or not |
| GET |
/v310/appliance/{uuid}/alertCounts |
Gets the number of notifications on appliance |
VMstoreOnly | | ApplianceAlertCounts - The number of notifications |
| GET |
/v310/appliance/{uuid}/certificate |
Returns any present host certificate and trusted Certificate Authority (CA) certificates. |
All | | Collection<Certificate> - any present host certificate and trusted Certificate Authority (CA) certificates. |
| PUT |
/v310/appliance/{uuid}/certificate |
Upload a certificate to VMstore. |
All | Certificate - the uploaded Certificate and the private key is applicable. | void |
| POST |
/v310/appliance/{uuid}/certificate/generate |
Generate new self-signed host certificate with hostname and IP address in the Subject Alternative Name extension on VMstore. |
VMstoreOnly - Since v310.41 | | void |
| GET |
/v310/appliance/{uuid}/certificate/{id} |
Returns certificate(s) that matche the certificate ID or empty collection if not found. |
All | | Collection<Certificate> - The collection that contains requested certificate if found, or it will be empty. |
| DELETE |
/v310/appliance/{uuid}/certificate/{id} |
Deletes a certificate by certificate ID. |
All | | void |
| GET |
/v310/appliance/{uuid}/component |
Gets the Tintri appliance components. |
VMstoreOnly - Since v310.31 | | List<ApplianceComponent> - The information about Tintri components. |
| POST |
/v310/appliance/{uuid}/connectivity/testPing |
Ping test. |
VMstoreOnly - Since v310.51 | PingTestRequest - which contains the source IP, host name or IP and a packetSize. | PingTestResult - The ping test result indicating if the test succeeded or not. |
| GET |
/v310/appliance/{uuid}/controller |
Gets the Tintri appliance controllers. |
VMstoreOnly - Since v310.31 | | List<ApplianceController> - The information about Tintri controllers. |
| GET |
/v310/appliance/{uuid}/customizationInfo |
Gets the Tintri appliance customization information, which includes replication interface and space saving support. |
VMstoreOnly | | ApplianceCustomizationInfo - Appliance customization information |
| GET |
/v310/appliance/{uuid}/dateTime |
Returns the date and time settings. |
All | | ApplianceDateTime - The date and time configuration for the appliance. |
| GET |
/v310/appliance/{uuid}/disk |
Gets the Tintri appliance disks. |
VMstoreOnly - Since v310.31 | | List<ApplianceDisk> - The information about Tintri disks. |
| GET |
/v310/appliance/{uuid}/dns |
Gets the Tintri appliance DNS setting. |
All | | ApplianceDns - The DNS configuration |
| GET |
/v310/appliance/{uuid}/emailalerts |
Gets the Tintri appliance alert email configuration. |
All | | ApplianceEmail - The appliance alert email configuration |
| POST |
/v310/appliance/{uuid}/enableEncryption |
Enables disk encryption. |
VMstoreOnly | KeyServer | ApplianceDiskEncryptionResult - The appliance disk encryption result |
| GET |
/v310/appliance/{uuid}/encryptionInfo |
Gets the disk encryption information. |
VMstoreOnly | | ApplianceDiskEncryptionInfo - The appliance disk encryption information |
| POST |
/v310/appliance/{uuid}/expand |
Deprecated. Expands the storage capacity of the Tintri appliance after successful HA failover, the additional capacity will be added to realstore's single large RAID group. |
All - Since v310.53 | | ApplianceCapacityErrorInfo - Error info if the Appliance capacity expansion request was not successfull otherwise null. |
| POST |
/v310/appliance/{uuid}/expand/async |
Expands the storage capacity of the Tintri appliance after successful HA failover, the additional capacity will be added to realstore's single large RAID group. |
VMstoreOnly - Since v310.141 | | Task - Task - status of the operation |
| GET |
/v310/appliance/{uuid}/failedComponents |
Gets the failed hardware parts that need to be replaced. |
VMstoreOnly | | ApplianceFailedComponents - The failed hardware parts |
| GET |
/v310/appliance/{uuid}/fileDirInfo/{path} |
Fetch the file system information associated with the entity specificed by path. |
VMstoreOnly - Since v310.91 | | FileSystemInfo - The FileSytemInfo associated with the entity. |
| POST |
/v310/appliance/{uuid}/hafailover |
API to perform HA failover. |
VMstoreOnly - Since v310.21 | | void |
| GET |
/v310/appliance/{uuid}/info |
Gets the Tintri appliance basic information, which includes serial number, model name, OS verison, and product ID. |
All | | ApplianceInfo - The basic information about Tintri appliance |
| GET |
/v310/appliance/{uuid}/ipmi |
Gets IPMI configuration. |
VMstoreOnly | | ApplianceIpmi - The IPMI configuration |
| GET |
/v310/appliance/{uuid}/ips |
Gets the Tintri appliance IP configurations. |
All | | List<ApplianceIp> - The list of appliance IP configurations |
| GET |
/v310/appliance/{uuid}/lacp |
Gets LACP configuration. |
VMstoreOnly | | ApplianceLacp - The LACP configuration |
| GET |
/v310/appliance/{uuid}/lldp |
Returns the LLDP info for both controllers. |
VMstoreOnly - Since v310.121 | | List<ApplianceLldpInfo> - the LLDP info for both controllers. |
| GET |
/v310/appliance/{uuid}/maintenanceMode |
Gets maintenance mode. |
VMstoreOnly | | ApplianceMaintenanceMode - The appliance maintenance mode |
| GET |
/v310/appliance/{uuid}/operationalStatus |
Gets the Tintri appliance operational status, which contains sample time, up time, count of unread alerts, file system status, urgent message. |
All | | ApplianceOperationalInfo - Appliance operational information |
| GET |
/v310/appliance/{uuid}/rbacExternalConfig |
Returns the external directory service authentication configuration. |
All | | RbacExternalConfig - the external directory service authentication configuration. |
| PUT |
/v310/appliance/{uuid}/rbacExternalConfig |
Updates the external directory service authentication configuration. |
All | RbacExternalConfig | void |
| POST |
/v310/appliance/{uuid}/reboot |
API to perform Appliance reboot operation |
VMstoreOnly - Since v310.11 | | void |
| POST |
/v310/appliance/{uuid}/rebootSecondary |
API to perform secondary reboot operation |
VMstoreOnly - Since v310.121 | | void |
| POST |
/v310/appliance/{uuid}/restartAuthd |
Restart the AuthenticationService (authd). |
All - Since v310.121 | | void |
| POST |
/v310/appliance/{uuid}/restartDb |
Restarts the application database. |
VMstoreOnly - Since v310.141 | | void |
| POST |
/v310/appliance/{uuid}/restartSnmp |
Restart the snmp-agent. |
All - Since v310.121 | | void |
| POST |
/v310/appliance/{uuid}/restartWebServer |
Restart the web server. |
All - Since v310.41 | | void |
| POST |
/v310/appliance/{uuid}/rotateEncryptionKey |
Rotates the disk encryption key. |
VMstoreOnly | | void |
| POST |
/v310/appliance/{uuid}/rpcReport |
Generates a report of external RPC connection to filesystem in /var/log/tintri/rpc-connections-external.txt |
VMstoreOnly - Since v310.141 | | void |
| POST |
/v310/appliance/{uuid}/shutdown |
API to perform Appliance shutdown operation |
VMstoreOnly - Since v310.11 | | void |
| GET |
/v310/appliance/{uuid}/snmp |
Gets the sytem SNMP configuration. |
VMstoreOnly | | ApplianceSnmp - ApplianceConfigSnmp |
| PUT |
/v310/appliance/{uuid}/snmp |
Updates the specified SNMP configuration. |
VMstoreOnly | ApplianceSnmp - SNMP configuration | void |
| GET |
/v310/appliance/{uuid}/snmpTarget |
Get all the SNMP trap targets information. |
VMstoreOnly | | Response - The list of all the SNMP trap target configurations. |
| POST |
/v310/appliance/{uuid}/snmpTarget |
Create a SNMP trap target. |
VMstoreOnly | ApplianceSnmpTarget - This is the SNMP trap target configuration. | void |
| GET |
/v310/appliance/{uuid}/snmpTarget/{targetid} |
Get the specified SNMP trap target configuration. |
VMstoreOnly | | ApplianceSnmpTarget - The SNMP trap configuration associated with the specified trap target ID. |
| DELETE |
/v310/appliance/{uuid}/snmpTarget/{targetid} |
Delete the specified SNMP trap target. |
VMstoreOnly | | void |
| PUT |
/v310/appliance/{uuid}/snmpTarget/{targetid} |
Updates the specified trap target configuration. |
VMstoreOnly | ApplianceSnmpTarget - This is the SNMP trap target configuration. | void |
| GET |
/v310/appliance/{uuid}/snmpUser |
Gets SNMP users. |
VMstoreOnly | | Response - The list of all the SNMP user configurations. |
| POST |
/v310/appliance/{uuid}/snmpUser |
Create a SNMP user with the specified configuration. |
VMstoreOnly | ApplianceSnmpUser - This contains the SNMP user configuration. | void |
| GET |
/v310/appliance/{uuid}/snmpUser/{username} |
Returns the SNMP configuration of the specified user. |
VMstoreOnly | | ApplianceSnmpUser - The SNMP user configuration associated with the specified user name. |
| DELETE |
/v310/appliance/{uuid}/snmpUser/{username} |
Remove the specified SNMP user. |
VMstoreOnly | | void |
| PUT |
/v310/appliance/{uuid}/snmpUser/{username} |
Updates the specified SNMP user configuration. |
VMstoreOnly | ApplianceSnmpUser - This contains the SNMP user configuration. | void |
| GET |
/v310/appliance/{uuid}/stagingAreaInfo |
Gets the Tintri appliance staging area information, which includes details about the space, software uploaded etc. |
TgcOnly - Since v310.81 | | ApplianceStagingAreaInfo - The appliance Staging Area information |
| GET |
/v310/appliance/{uuid}/stagingAreaInfo/availableSoftwares |
Gets the Tintri appliance staging area available software information, which includes details of the software uploaded etc. |
TgcOnly - Since v310.81 | | List<ApplianceStagingAvailableSoftware> - The appliance staging area available software information |
| POST |
/v310/appliance/{uuid}/stagingAreaInfo/availableSoftwares/cancelupgrade |
Cancel the VMstore software upgrade. |
TgcOnly - Since v310.81 | List<String> - . List of upgrade of appliance UUIDs that needs to be cancelled. | List<Task> - a list of tasks, one per appliance |
| DELETE |
/v310/appliance/{uuid}/stagingAreaInfo/availableSoftwares/{softwareuuid} |
Deprecated. Delete the specified TxOS software from the staging area. |
TgcOnly - Since v310.81 | | Response |
| DELETE |
/v310/appliance/{uuid}/stagingAreaInfo/availableSoftwares/{softwareuuid}/error |
Delete the specified TxOS software from the staging area and clears upgrade validation errors. |
TgcOnly - Since v310.101 | List<String> - . List of upgrade of appliance UUIDs that needs to be cancelled. | Response |
| POST |
/v310/appliance/{uuid}/stagingAreaInfo/availableSoftwares/{softwareuuid}/startupgrade |
Upgrades the TXOS software to the specified VMstores. |
TgcOnly - Since v310.81 | List<String> - List of appliance UUIDs that needs to be upgraded. | List<Task> - a list of tasks, one per appliance |
| GET |
/v310/appliance/{uuid}/support |
Gets the Tintri appliance autosupport settings. |
All | | ApplianceSupport - The appliance auto-support settings. |
| GET |
/v310/appliance/{uuid}/syslogForwarding |
Gets the log forwarding info. |
VMstoreOnly | | ApplianceSyslogForwarding - ApplianceSyslogForwarding |
| GET |
/v310/appliance/{uuid}/temperature |
Gets the Tintri appliance termperatures. |
VMstoreOnly - Since v310.31 | | List<Temperature> - The information about Tintri temperatures. |
| POST |
/v310/appliance/{uuid}/testEmail |
Tests alert mail. |
All - Since v310.41 | ApplianceEmail - e-mail address | Response - The response to indicate if the test email is successful or not |
| POST |
/v310/appliance/{uuid}/testEncryption |
Tests disk encryption. |
VMstoreOnly - Since v310.61 | KeyServer - Key Server configuration | ApplianceDiskEncryptionResult - The appliance disk encryption result |
| POST |
/v310/appliance/{uuid}/testRbacExternalConfig |
Test the external directory service authentication configuration. |
All | RbacExternalConfig | List<RbacTestResult> |
| PUT |
/v310/appliance/{uuid}/testRbacExternalConfig |
Deprecated. Test the external directory service authentication configuration. |
All | RbacExternalConfig | List<RbacTestResult> |
| POST |
/v310/appliance/{uuid}/testSNMP |
Send a SNMP test trap to a remote trap receiver host. |
VMstoreOnly | Request<ApplianceSnmp> - This contains the user security and remote host information. | Response - Formatted error message if operation fails. |
| POST |
/v310/appliance/{uuid}/testSyslogForwarding |
Send a test log forwarding message to the remote host. |
VMstoreOnly - Since v310.41 | Request<ApplianceSyslogForwarding> - This contains the remote host address. | Response - Formatted error message if operation fails. |
| GET |
/v310/appliance/{uuid}/timezones |
Returns list of all time zones supported by the server. |
All | | List<String> - The list of string representation of time zones |
| POST |
/v310/appliance/{uuid}/upgrade |
Starts the Tintri appliance upgrade. |
All - Since v310.41 | | Response - The respond to indicate if request is successful or not |
| GET |
/v310/appliance/{uuid}/upgradeInfo |
Gets the Tintri appliance upgrade information, which includes upgrade state, checksum, verison, error message. |
All | | ApplianceUpgradeInfo - The appliance upgrade information |
| POST |
/v310/autosupport/nightly |
Generate a report with summary information about the past 25 hours. |
All | | String - The filename of the generated report, which can be found within the 'phonehome' log subdirectory. |
| GET |
/v310/autosupport/reportInfo |
Gets the Tintri appliance autosupport report creation information, which includes the time stamp, progress, description of each report creation steps. |
All - Since v310.31 | | TintriString - The appliance autosupport report creation information |
| POST |
/v310/autosupport/support |
Generate a support bundle. |
All | | String - The filename of the generated report, which can be found within the 'phonehome' log subdirectory. |
| GET |
/v310/clusterConfig |
Returns current cluster configuration |
TgcOnly | | ClusterConfiguration - ClusterConfiguration |
| PUT |
/v310/clusterConfig |
Update current cluster configuration |
TgcOnly | ClusterConfiguration - The new ClusterConfiguration | void |
| GET |
/v310/computeResource |
Get configuration and performance data about compute resources in a paginated response. |
All | | Page - Paginated items representing compute resources. |
| GET |
/v310/datastore |
Get all datastore properties. |
All | | List<Datastore> - List of datastores. |
| GET |
/v310/datastore/{uuid} |
Get the specified datastore properties. |
All | | Datastore - Datastore datastore properties. |
| PUT |
/v310/datastore/{uuid} |
Updates the specified properties of the specified datastore. |
VMstoreOnly | Request<Datastore> - A request wrapper containing the datastore attributes to be modified set in the object and a properties set listing the attributes to be updated. | void |
| GET |
/v310/datastore/{uuid}/customizationSpec/{vcenterName}?refresh=… |
Gets the customization specifications of the datastore for the specified vCenter. |
VMstoreOnly | | List<VirtualMachineCustomizationSpec> - The list of virtual machine customization specifications for the specified datastore and vCenter. |
| DELETE |
/v310/datastore/{uuid}/deleteAllCloudReplication |
Deletes all per VM configurations that point to a cloud replication Link. |
All - Since v310.71 | | void |
| DELETE |
/v310/datastore/{uuid}/deleteAllReplication |
Deletes all per VM configurations that point to a asynchronous replication Link. |
All - Since v310.71 | | void |
| POST |
/v310/datastore/{uuid}/directory |
Create a new directory under /tintri. |
VMstoreOnly - Since v310.100 | FileSystemInfo | String - |
| GET |
/v310/datastore/{uuid}/fileShare |
Gets all FileShares on a given datastore. |
VMstoreOnly - Since v310.11 | | List<FileShare> - A list of file shares |
| POST |
/v310/datastore/{uuid}/fileShare |
Creates a FileShare. |
VMstoreOnly - Since v310.11 | FileShare - The FileShare to create. | FileShare - The created FileShare. |
| GET |
/v310/datastore/{uuid}/fileShare/{fsName} |
Gets a specific FileShare given the FileShare name. |
VMstoreOnly - Since v310.11 | | FileShare - The FileShare. |
| PUT |
/v310/datastore/{uuid}/fileShare/{fsName} |
Updates a FileShare. |
VMstoreOnly - Since v310.31 | Request<FileShare> - Desired parameters for the new FileShare. | void |
| DELETE |
/v310/datastore/{uuid}/fileShare/{fsName} |
Deletes the specified FileShare. |
VMstoreOnly - Since v310.11 | | void |
| GET |
/v310/datastore/{uuid}/fileShare/{fsName}/acl |
Gets the access control list (ACL) of a specified FileShare. |
VMstoreOnly - Since v310.11 | | Acl - The Acl (access control list). |
| POST |
/v310/datastore/{uuid}/fileShare/{fsName}/acl |
Creates a specified access control entry (ACE) on a FileShare. |
VMstoreOnly - Since v310.11 | Ace - The Ace (access control entry) to create. | Ace - The created Ace (access control entry). |
| GET |
/v310/datastore/{uuid}/fileShare/{fsName}/acl/{aceId} |
Gets a specific access control entry (ACE) of a specified FileShare and access control entry ID. |
VMstoreOnly - Since v310.11 | | Ace - The Ace (access control entry). |
| DELETE |
/v310/datastore/{uuid}/fileShare/{fsName}/acl/{aceId} |
Deletes the specified access control entry (ACE) from a FileShare. |
VMstoreOnly - Since v310.11 | | void |
| PUT |
/v310/datastore/{uuid}/fileShare/{fsName}/resetFileAcls |
Resets the permissions of all the files on the specified share |
VMstoreOnly - Since v310.71 | boolean - 'TRUE' removes the existing (custom) file permissions on the specified share; 'FALSE' preserves the share's file permissions | void |
| GET |
/v310/datastore/{uuid}/hostResources |
Returns a list of host resources, Host, Resource Pool, Cluster, Compute Resource, etc. |
VMstoreOnly | | List<VirtualMachineHostResource> - The list of virtual machine host resources for the specified datastore. |
| GET |
/v310/datastore/{uuid}/hypervisorDatastore |
Get all hypervisor datastores. |
VMstoreOnly | | List<HypervisorDatastore> - A list of hypervisor datastore infromation. |
| POST |
/v310/datastore/{uuid}/hypervisorManagerConfig |
Adds hypervisor manager configuration |
VMstoreOnly - Since v310.21 | List<HypervisorManagerConfig> - List of HypervisorManagaerConfig objects with hypervisor manager information | void |
| GET |
/v310/datastore/{uuid}/hypervisorManagerConfig |
Gets hypervisor manager configuration |
VMstoreOnly - Since v310.21 | | List<HypervisorManagerConfig> - A list of configured Hypervisor Managers |
| DELETE |
/v310/datastore/{uuid}/hypervisorManagerConfig/{managerConfigId} |
Delete hypervisor manager configuration |
VMstoreOnly - Since v310.21 | | void |
| PUT |
/v310/datastore/{uuid}/hypervisorManagerConfig/{managerConfigId} |
Updates username or password of already configured hypervisor manager. |
VMstoreOnly - Since v310.21 | Request<HypervisorManagerConfig> - - HypervisorManagerConfig with new username/password or both | void |
| GET |
/v310/datastore/{uuid}/hypervisorManagerConfig/{managerId}?refresh=… |
Gets hypervisor manager configuration for given manager id and optionally refreshes the manager. |
VMstoreOnly - Since v310.171 | | HypervisorManagerConfig - the hypervisor manager config |
| POST |
/v310/datastore/{uuid}/hypervisorManagerStatus |
Ping hypervisor managers configured on the Datastore |
VMstoreOnly - Since v310.21 | List<HypervisorManagerConfig> | List<HypervisorManagerConfig> - Status of the ping calls to hypervisor managers |
| GET |
/v310/datastore/{uuid}/hypervisorManagersFromAD |
Find potential Hyper-V hosts from Active Directory that this Datastore can manage. |
VMstoreOnly - Since v310.31 | | List<HypervisorManagerConfig> - Status of the find calls to potential hypervisor managers |
| GET |
/v310/datastore/{uuid}/k8s/container |
Returns k8s containers in paginated form as specified by filter parameters in request. |
All - Since v310.171 | | Page - |
| GET |
/v310/datastore/{uuid}/k8s/deployment |
Returns k8s deployments in paginated form as specified by filter parameters in request. |
All - Since v310.171 | | Page - |
| GET |
/v310/datastore/{uuid}/k8s/namespace |
Returns k8s namespaces in paginated form as specified by filter parameters in request. |
All - Since v310.171 | | Page - |
| GET |
/v310/datastore/{uuid}/k8s/pod |
Returns k8s pods in paginated form as specified by filter parameters in request. |
All - Since v310.171 | | Page - |
| GET |
/v310/datastore/{uuid}/k8s/pv |
Returns k8s persistent volumes in paginated form as specified by filter parameters in request. |
All - Since v310.171 | | Page - |
| GET |
/v310/datastore/{uuid}/k8s/pvc |
Returns k8s persistent volume claims in paginated form as specified by filter parameters in request. |
All - Since v310.171 | | Page - |
| GET |
/v310/datastore/{uuid}/nfsaccess |
Gets the NFS access control list and the NFS access enabled flag. |
VMstoreOnly | | DatastoreNfsAccesses - The NFS access control list and the NFS access enabled flag. |
| PUT |
/v310/datastore/{uuid}/nfsaccess |
Sets the NFS access control list and the NFS access enabled flag. |
VMstoreOnly | DatastoreNfsAccesses - The full NFS access control settings to replace the current settings. | void |
| POST |
/v310/datastore/{uuid}/pauseAsyncSyncReplication |
Pause asynchronous and synchronous replication |
All - Since v310.71 | | void |
| POST |
/v310/datastore/{uuid}/pauseCloudReplication |
Pause cloud replication |
All - Since v310.71 | | void |
| GET |
/v310/datastore/{uuid}/qosInfo |
Returns the system-wide QoS information such as total minimum IOPS allocated. |
VMstoreOnly - Since v310.21 | | DatastoreQoSInfo - The system QoS Info. |
| GET |
/v310/datastore/{uuid}/replicationConfig |
Returns the system-wide replication configuration |
All | | VirtualMachineReplicationConfig - The system virtual machine replication configuration for the datastore. |
| PUT |
/v310/datastore/{uuid}/replicationConfig |
Update the system replication configuration, for example, from system disabled to system enabled. |
VMstoreOnly | VirtualMachineReplicationConfig - The system virtual machine replication configuration to update. | void |
| GET |
/v310/datastore/{uuid}/replicationInfo |
Gets the replication properties. |
All | | DatastoreReplicationInfo - The system replication imformation of the datastore. |
| PUT |
/v310/datastore/{uuid}/replicationInfo |
Updates the specified replication properties on the specified datastore instance by the incoming replication properties instance. |
All | Request<DatastoreReplicationInfo> - A request wrapper containing the datastore replication path attributes to be modified set in the object and a properties set listing the attributes to be updated. | void |
| POST |
/v310/datastore/{uuid}/replicationPath |
Creates a new replication path and adds it to this datastore as an outgoing replication path. |
All | DatastoreReplicationPath - The replication link to create. | DatastoreReplicationPath - The created datastore replication path. |
| PUT |
/v310/datastore/{uuid}/replicationPath |
Updates the specified replication link on the specified datastore instance by the incoming replication instance. |
All | Request<DatastoreReplicationPath> - A request wrapper containing the datastore replication path attributes to be modified set in the object and a properties set listing the attributes to be updated. | void |
| GET |
/v310/datastore/{uuid}/replicationPath |
Gets all of the replication paths. |
All | | List<DatastoreReplicationPath> - A list of outgoing replication paths. |
| PUT |
/v310/datastore/{uuid}/replicationPath/test |
Deprecated. Tests the specified replication link on the specified datastore instance. |
VMstoreOnly | Request<TestReplicationPath> - Replication link to test. | String - The result of the test. An empty string on success. If only encrypton is being tested then the reason for the failure is returned. |
| DELETE |
/v310/datastore/{uuid}/replicationPath/{smReplLinkId} |
Deletes the specified replication path on the specified datastore instance. |
All | | void |
| PUT |
/v310/datastore/{uuid}/schedulesDefault |
Updates a system snapshot schedule |
VMstoreOnly | VirtualMachineSnapshotSchedule - The snapshot schedule to be updated. | void |
| GET |
/v310/datastore/{uuid}/schedulesDistinct |
Gets a list of distinct snapshot schedules, max of 100, including the system default snapshot schedules. |
VMstoreOnly | | List<VirtualMachineSnapshotSchedule> - A list of unique virtual machine snapshot schedules with a max of 100. |
| GET |
/v310/datastore/{uuid}/smbSettings |
Gets the SMB settings and the SMB settings enabled flag. |
VMstoreOnly - Since v310.11 | | DatastoreSmbSettings - The DatastoreSmbSettings, including the data path SMB host name. |
| PUT |
/v310/datastore/{uuid}/smbSettings |
Sets the SMB settings and the SMB settings enabled flag. |
VMstoreOnly - Since v310.11 | DatastoreSmbSettings - The DatastoreSmbSettings, including the data path SMB host name. | void |
| POST |
/v310/datastore/{uuid}/statsDownloadable |
Create a URL for retrieving the system historical performance statistics report which is returned as output. |
TgcOnly | DatastoreStatDownloadableReportFilter - The filer for generating the report. | String - The URL that the user can use to retrieve the historic datastore statistics report. |
| GET |
/v310/datastore/{uuid}/statsHistoric |
Gets the historic datastore performance slices containing all of the statistics for the datastore. |
All | | Page - Paginated items containing a list of . |
| GET |
/v310/datastore/{uuid}/statsRealtime |
Gets the real time datastore performance slice containing all of the statistics for the datastore. |
All | | Page - Paginated items contining a list of . |
| GET |
/v310/datastore/{uuid}/statsSummary |
Gets the latest historic datastore performance slice containing all of the statistics for the datastore. |
All | | DatastoreStat - The latest statistics for the datastore. |
| GET |
/v310/datastore/{uuid}/systemProperty |
Returns a list of system properties and related information. |
VMstoreOnly - Since v310.64 | | List<SystemProperty> - the list of system properties and related information, empty list if no system properties found |
| PUT |
/v310/datastore/{uuid}/systemProperty |
Updates the specified system property's custom value. |
VMstoreOnly - Since v310.64 | SystemProperty - The system property where only "name" and "value" attributes are required, not null | void |
| GET |
/v310/datastore/{uuid}/systemProperty/{propertyName} |
Get information on the specified system property given the property name. |
VMstoreOnly - Since v310.64 | | SystemProperty - The System Property |
| DELETE |
/v310/datastore/{uuid}/systemProperty/{propertyName} |
Removes the specified system property's custom value, and restores the default value. |
VMstoreOnly - Since v310.64 | | void |
| GET |
/v310/datastore/{uuid}/tag |
Returns hypervisor tags in paginated form as specified by filter parameters in request. |
All - Since v310.141 | | Page - |
| GET |
/v310/datastore/{uuid}/tag/{tagId} |
Returns hypervisor tag information for tag with given tagId. |
All - Since v310.141 | | List<TagCollection> - List
|
| POST |
/v310/datastore/{uuid}/testReplicationPath |
Tests the specified replication link on the specified datastore instance. |
All - Since v310.41 | Request<TestReplicationPath> - The replication link to test. | String - The result of the test. An empty string on success. If only encrypton is being tested then the reason for the failure is returned. |
| PUT |
/v310/datastore/{uuid}/testSmbConfig |
Test SMB host name configuration. |
VMstoreOnly - Since v310.11 | SmbConfig - SMB configuration | List<SmbTestResult> - The list of test results |
| POST |
/v310/license |
Adds a license. |
All | License - is the feature and model information to add a license | License - the validated license. |
| GET |
/v310/license |
Returns a list of all the licenses. |
All | | List<License> - the found licenses. |
| POST |
/v310/license/bulk |
Adds one or more licenses. |
TgcOnly - Since v310.51 | String - is a string of one or more license keys separated by comma, space, or line break | List<License> - the validated or failed licenses. |
| GET |
/v310/license/eval |
Returns a list of all the evaluation licenses. |
All - Since v310.71 | | List<License> - the list of evaluation licenses. |
| POST |
/v310/license/eval/{feature} |
Activates an evaluation license for a feature. |
All - Since v310.71 | | License - the validated license. |
| POST |
/v310/license/licenseListDownloadable |
Create a URL for retrieving the license list report which is returned as output. |
TgcOnly - Since v310.51 | LicenseDownloadableReportFilter - The LicenseDownloadableReportFilter for generating the report. | String - The URL that the user can use to retrieve the Licenses list report. |
| GET |
/v310/license/summary |
Returns a summary of the number of license types (i.e. |
TgcOnly - Since v310.51 | | LicenseSummary - the LicenseSummary |
| DELETE |
/v310/license/{key} |
Removes a license resource identified by the license key. |
All | | void |
| POST |
/v310/quorumServer |
Adds a quorumServer |
TgcOnly | QuorumServerInfo | String - If successful returns Tintri UUID of the newly created quorum server, else error message. |
| GET |
/v310/quorumServer |
Returns a list of all the quorum servers. |
TgcOnly | | List<QuorumServerInfo> - the found quorum servers. |
| DELETE |
/v310/quorumServer/{id} |
Removes a quorum server identified by the given id. |
TgcOnly | | void |
| GET |
/v310/replTopology |
Gets the replication links. |
TgcOnly | | List<ReplLink> - List
Return all the replication links
|
| GET |
/v310/role |
Returns a collection of fixed access control Role instances. |
All | | Collection<GenericRestApiRole> - a collection of fixed access control Role instances. |
| GET |
/v310/role/external |
Returns a collection of external groups from external directory service. |
All | | Collection<GenericRestApiRole> - a collection of external groups from external directory service. |
| GET |
/v310/role/external/filter |
Returns a paginated collection of external groups containing the name query parameter up to the limit query parameter. |
All - Since v310.121 | | Page - Paginated external groups with list of items |
| GET |
/v310/role/external/{id} |
Returns an access control Role that matches the external group ID. |
All | | GenericRestApiRole - an access control Role that matches the external group ID. |
| GET |
/v310/role/{id} |
Returns an access control Role by instance Tintri UUID. |
All | | GenericRestApiRole - an access control Role by instance Tintri UUID. |
| PUT |
/v310/role/{id} |
Associates a collection of external groups with an access control Role. |
All | Collection<String> - A list of external group IDs. | void |
| GET |
/v310/servicegroup |
Get page list of service groups. |
All | | Page - Paginated items known to this API server. Service groups can be defined or created on a different servers. |
| POST |
/v310/servicegroup |
Create a new service group. |
All | ServiceGroup - New ServiceGroup to be created | String - If successful returns Tintri UUID of the newly created service group, else error message. |
| PUT |
/v310/servicegroup |
Update an existing service group. |
All - Since v310.61 | ServiceGroup - ServiceGroup with new attribute values. | void |
| POST |
/v310/servicegroup/svgListDownloadable |
Create a URL for retrieving service group report which is returned as output. |
TgcOnly | SvgDownloadableReportFilter - The filter for generating the report. | String - The URL that the user can use to retrieve the service group list report. |
| POST |
/v310/servicegroup/syncRepl/pause |
On VMStore, this will pause all synchronous replication configurations at the system level. |
All - Since v310.61 | SyncReplPauseResumeRequest - On VMStore, this input must be ignored. TGC will specify the uuid parameter in the input request, to identify the VMStore on which all the synchronous replication configurations should be paused. | List<TintriError> |
| POST |
/v310/servicegroup/syncRepl/resume |
On VMStore, this will resume all synchronous replication configurations at the system level. |
All - Since v310.61 | SyncReplPauseResumeRequest - On VMStore, this input must be ignored. TGC will specify the uuid parameter in the input request, to identify the VMStore on which all the the synchronous replication configurations should be resumed | List<TintriError> |
| POST |
/v310/servicegroup/syncRepl/test |
Test the Synchronous Replication configuration associated with the specified . |
All - Since v310.61 | ServiceGroup - New or existing ServiceGroup to be tested, it should contain non-null SyncReplConfig otherwise error will be thrown. | SyncReplTestResult - SyncReplState will tell us how the test result looks like. |
| POST |
/v310/servicegroup/syncRepl/test/quorumServer |
Test the synchronous replication quorum server status represented by the given parameter. |
All - Since v310.95 | QuorumServerInfo | SyncReplTestResult - |
| POST |
/v310/servicegroup/syncRepl/test/quorumServer/{vmStoreUuid} |
Test the quorum server connection status represented by the given VMstore UUID. |
TgcOnly - Since v310.95 | QuorumServerInfo | SyncReplTestResult - |
| GET |
/v310/servicegroup/{id} |
Returns the service group associated with the specified ID. |
All | | ServiceGroup - Paginated items. |
| DELETE |
/v310/servicegroup/{id} |
Delete a specific service group. |
All | | ServiceGroup - ServiceGroup which was deleted. |
| GET |
/v310/servicegroup/{id}/members |
Return the service group members associcated with the specified ID.. |
All | | Page - Paginated items. |
| PUT |
/v310/servicegroup/{id}/members/static |
Update statically assigned members for the given service group. |
TgcOnly - Since v310.21 | CollectionChangeRequest | void |
| GET |
/v310/servicegroup/{id}/operationStatus |
Return the current or last service group operation associated with protection of the specified service group. |
TgcOnly | | ServiceGroupOperationStatus - ServiceGroupOperationStatus None if no operation was run. |
| POST |
/v310/servicegroup/{id}/policy |
Apply the policy configured by PUT to all members in the service group for the given service group. |
TgcOnly | | void |
| PUT |
/v310/servicegroup/{id}/policyConfig |
Replace the protection policy (both snapshot schedules and replication configuration) for the given service group. |
TgcOnly - Since v310.21 | PolicyConfig - PolicyConfig to be replaced | void |
| GET |
/v310/servicegroup/{id}/policyConfig |
Returns the PolicyConfig associated with the given service group. |
TgcOnly - Since v310.21 | | PolicyConfig - PolicyConfig the policy associated with the given service group |
| POST |
/v310/servicegroup/{id}/qos |
Apply the QoS configured by update QoS Config API to all members in the service group for the given service group. |
TgcOnly | | void |
| GET |
/v310/servicegroup/{id}/qos/operationStatus |
Return the current or last service group operation associated with QoS of the specified service group. |
TgcOnly | | ServiceGroupOperationStatus - ServiceGroupOperationStatus None if no operation was run. |
| PUT |
/v310/servicegroup/{id}/qosConfig |
Update the QoS policy for the given service group. |
TgcOnly - Since v310.31 | VirtualMachineQoSConfig - qosConfig to be replaced | void |
| GET |
/v310/servicegroup/{id}/qosConfig |
Returns the QoS configuration associated with the given service group. |
TgcOnly - Since v310.31 | | VirtualMachineQoSConfig - QoSConfig the QoS associated with the given service group |
| GET |
/v310/servicegroup/{id}/quota/statsHistoric |
Get all of the historic quota statistics slices for the service group. |
All - Since v310.71 | | Page - Paginated items containing a list of . |
| GET |
/v310/servicegroup/{id}/quotaPolicy |
Returns the quota policy associated with the given service group. |
All - Since v310.71 | | QuotaPolicy - QuotaPolicy the quota policy associated with the given service group |
| POST |
/v310/servicegroup/{id}/quotaPolicy |
Create a quota policy for the given service group. |
All - Since v310.71 | QuotaPolicy - quotaPolicy to be created | void |
| PUT |
/v310/servicegroup/{id}/quotaPolicy |
Update the quota policy for the given service group. |
All - Since v310.71 | QuotaPolicy - quotaPolicy containing new values | void |
| DELETE |
/v310/servicegroup/{id}/quotaPolicy |
Delete the quota policy associated with the given service group. |
All - Since v310.71 | | QuotaPolicy - QuotaPolicy the deleted quota policy. |
| GET |
/v310/servicegroup/{id}/replConfig |
Getter for the replication configuration associated with the service group. |
All - Since v310.61 | | VirtualMachineReplicationConfig - VirtualMachineReplicationConfig Return the replication configuration associated with the service group. |
| PUT |
/v310/servicegroup/{id}/rules |
Update rules for a given service group. |
TgcOnly - Since v310.21 | ServiceGroupRules | void |
| GET |
/v310/servicegroup/{id}/snapshotSchedules |
Returns list of snapshot schedules which will be applied to members of this service group. |
All | | List<VirtualMachineSnapshotSchedule> - List
List of snapshot schedules associated the service group.
|
| GET |
/v310/servicegroup/{id}/srmConfig |
Return SRM configuration associated with this service group. |
All | | SrmConfig - SrmConfig None if no SRM Configuration is associated. |
| POST |
/v310/servicegroup/{id}/syncRepl/makePrimary |
Initiate a failover from this VMstore. |
All - Since v310.61 | SyncReplMakePrimaryRequest - SyncReplMakePrimaryRequest | void |
| POST |
/v310/servicegroup/{id}/syncRepl/pause |
Pause the specified synchronous replication configuration. |
All - Since v310.61 | | void |
| POST |
/v310/servicegroup/{id}/syncRepl/resume |
Resume the specified synchronous replication configuration. |
All - Since v310.61 | | void |
| GET |
/v310/servicegroup/{id}/syncRepl/statsHistoric |
Get all of the historic synchronous replication performance slices for the service group. |
All | | Page - Paginated items containing a list of . |
| GET |
/v310/servicegroup/{id}/syncRepl/statsRealtime |
Get Synchronous Replication real time statistics. |
VMstoreOnly - Since v310.61 | | Page - Paginated items containing a list of . |
| POST |
/v310/servicegroup/{uuid}/statsDownloadable |
Create a URL for retrieving the service group historical performance statistics report which is returned as output. |
TgcOnly - Since v310.71 | SvgStatsDownloadableReportFilter - The filter for generating the report. | String - The URL that the user can use to retrieve the historic service group statistics report. |
| GET |
/v310/session/active |
Returns a list of user sessions information that are currently logged in. |
All - Since v310.51 | | List<UserSession> - list of user sessions |
| GET |
/v310/session/active/tintricenter |
Returns a list of user sessions belongs to user=tintricenter. |
VMstoreOnly - Since v310.111 | | List<UserSession> - list of tintricenter sessions |
| GET |
/v310/session/current |
Returns the current user session information. |
All - Since v310.51 | | UserSession - current user session |
| POST |
/v310/session/login |
Creates session on Tintri API server after successful authentication and authorization. |
All | RestApiCredentials - The credentials to login to the REST API server. Full API version is an optional attribute inside it and the default 'v310.1' will be used if not provided | String - The role name of the credentials |
| POST |
/v310/session/logout |
Logout from Tintri API server session. |
All | | void |
| GET |
/v310/session/logout |
Deprecated. Logout from Tintri API server session. |
All | | void |
| GET |
/v310/session/ssoauth |
Creates a valid session after successful authentication with Kerberos tickets and successful authorization on Tintri API server. |
VMstoreOnly | | String - Returns Tintri Role name associated with the credentials |
| POST |
/v310/session/{tintriSessionId}/invalidate |
Invalidate a session by a user belonging to "Admin" role. |
All - Since v310.71 | | void |
| GET |
/v310/snapshot |
Fetches snapshot information based on the snapshot related query string parameters. |
All | | Page - Paginated items. |
| POST |
/v310/snapshot |
Takes a manual snapshot for a list of VMs. |
VMstoreOnly | List<SnapshotSpec> | List<String> - a list of Snapshot Tintri UUIDs |
| DELETE |
/v310/snapshot |
Removes snapshots that belongs to a VM, which vmUuid is a mandatory field. |
VMstoreOnly | | String - formatted string response message about snapshot deletion. |
| DELETE |
/v310/snapshot/remote/{tintriUuid}/{instanceId} |
Removes remote snapshot resource identified by snapshot Tintri UUID, for example on cloud. |
VMstoreOnly | | String - formatted string response message about snapshot deletion. |
| POST |
/v310/snapshot/restore |
Restore a snapshot from cloud as specified by the snapshot restore specification. |
All - Since v310.71 | SnapshotRestoreSpec - snapshot restore specification | Task - Task representing the progress of snapshot restore from cloud |
| GET |
/v310/snapshot/{tintriSnapshotUuid}/disks |
Fetches disks of a snapshot. |
VMstoreOnly - Since v310.21 | | List<VirtualDisk> - the VirtualDisk objects of snapshot. |
| GET |
/v310/snapshot/{tintriUuid} |
Fetches a snapshot by Tintri UUID. |
VMstoreOnly | | Snapshot - the particular snapshot as specified by snapshotId in the URI in the form of a Tintri UUID. |
| DELETE |
/v310/snapshot/{tintriUuid} |
Removes snapshot resource identified by snapshot Tintri UUID. |
VMstoreOnly | | String - formatted string response message about snapshot deletion. |
| GET |
/v310/task |
Return a paginated set of Tasks |
All | | Page - Paginated items.
TGC Examples using refresh query parameter:
- Fetch tasks from all VMstores managed by TGC
/api/v310/task?refresh=true
- Fetch tasks from a VMstore with TGC TintriUUID: TIN-87f37d16-8d9a-415e-8c98-d15cca6e4a37
/api/v310/task?refresh=true&vmstoreTintriIds=TIN-87f37d16-8d9a-415e-8c98-d15cca6e4a37
- Fetch tasks from two VMstores with TGC TintriUUIDs: TIN-87f37d16-8d9a-415e-8c98-d15cca6e4a37 and TIN-5f41fd4f-f5de-4eae-a131-98645a3ca4f2
/api/v310/task?refresh=true&vmstoreTintriIds=TIN-87f37d16-8d9a-415e-8c98-d15cca6e4a37,TIN-5f41fd4f-f5de-4eae-a131-98645a3ca4f2
- Fetch a specific task using VMstore's task ID: cloneVM@07-01-18:43:03.653
/api/v310/task?refresh=true&vmstoreTaskId=cloneVM@07-01-18:43:03.653&vmstoreTintriIds=TIN-87f37d16-8d9a-415e-8c98-d15cca6e4a37
|
| DELETE |
/v310/task/{id} |
Cancel a job by jobId |
All | | void |
| GET |
/v310/task/{id} |
Returns a job by Id |
All | | Task - JobEntity |
| PUT |
/v310/task/{id}/acknowledge |
Acknowledge a job |
VMstoreOnly | | void |
| GET |
/v310/userAccount |
Return a collection of UserAccount objects configured in the system. |
All | | Collection<UserAccount> - a collection of UserAccount objects configured in the system. |
| POST |
/v310/userAccount |
Creates a user account. |
All | UserAccount | UserAccount - the created UserAccount object. |
| POST |
/v310/userAccount/resetPassword |
Resets the password of a local user. |
All | RestApiCredentials | void |
| DELETE |
/v310/userAccount/{id} |
Delete a local user by UserAccount Tintri UUID. |
All | | void |
| GET |
/v310/userAccount/{id} |
Return an UserAccount object by Tintri UUID. |
All | | UserAccount - an UserAccount object by Tintri UUID. |
| PUT |
/v310/userAccount/{id} |
Updates the specified properties by values of passed UserAccount instance. |
All | Request<UserAccount> | void |
| GET |
/v310/userAgreement |
Returns user agreement. |
All | | UserAgreement |
| PUT |
/v310/userAgreement |
Update the user agreement |
All | UserAgreement - - Updated UserAgreement | void |
| GET |
/v310/virtualDisk |
Returns information about virtual disks. |
VMstoreOnly | | Page - Paginated items. |
| GET |
/v310/virtualDisk/filter |
Return virtual disk filter scope. |
VMstoreOnly | | CommonStatFilterScope |
| PUT |
/v310/virtualDisk/{vmId}/{vdiskId}/pin |
Operation will pin the Virtual Disk of the VM to Flash storage in case of hybrid platform. |
VMstoreOnly - Since v310.21 | | void |
| GET |
/v310/virtualDisk/{vmId}/{vdiskId}/statsHistoric |
Performance historic trend data for the virtual disk |
VMstoreOnly | | Page - Paginated items contining a list of . |
| GET |
/v310/virtualDisk/{vmId}/{vdiskId}/statsRealtime |
Latest performance trend data for the virtual disk |
VMstoreOnly | | Page - Paginated items contining a list of . |
| PUT |
/v310/virtualDisk/{vmId}/{vdiskId}/unpin |
Operation will unpin the Virtual Disk of the VM from Flash storage in case of hybrid platform. |
VMstoreOnly - Since v310.21 | | void |
| GET |
/v310/vm |
Return information on virtual machines in a pagenated form as specified by the request parameters. |
All | | Page - Paginated items representing VMs. |
| POST |
/v310/vm |
Creates a clone of Virtual machine. |
All | VirtualMachineCloneSpec - Specifies source VM/snapshot and clone destination properties for the clone operation. | Task - Task It is used to get the progress of the clone operation through Task APIs. |
| PUT |
/v310/vm/deleteSyncDisks |
Delete all the virtual disks that restored via SyncVM File-Level Restore operation for each of the targeted virtual machine. |
VMstoreOnly - Since v310.31 | List<String> - A list of Tintri VM UUIDs | void |
| GET |
/v310/vm/filter |
Returns VM properties as specified by a filter request such as performance stats minimum and maximum filter limits. |
VMstoreOnly | | VmFilterScope - VmFilterScope |
| GET |
/v310/vm/filterScope |
Returns available filter properties. |
TgcOnly | | FilterScope - FilterScope |
| GET |
/v310/vm/policyErrorStat |
Return a list of current policy errors, and the number of VMs affected by each type of error. |
TgcOnly | | Page - Paginated items. |
| PUT |
/v310/vm/qosConfig |
Update multiple VM's QoS settings. |
VMstoreOnly - Since v310.21 | MultipleSelectionRequest<VirtualMachineQoSConfig> - the VirtualMachineQoSConfig MultipleSelectionRequest | void |
| POST |
/v310/vm/replicationConfig |
Deprecated. Create a new replication configuration for the specified VMs. |
VMstoreOnly | MultipleSelectionRequest<VirtualMachineReplicationConfig> - MultipleSelectionRequest of type VirtualMachineReplicationConfig containing the VM UUIDs and replication configuration information. | List<VirtualMachineReplicationConfig> - List of VirtualMachineReplicationConfig objects created for the specified VMs |
| POST |
/v310/vm/sync |
Synchronize a Virtual Machine to one of its snapshots. |
VMstoreOnly - Since v310.21. | VirtualMachineSyncSpec | Task |
| PUT |
/v310/vm/thinProvision |
Convert a collection of VMs and all their files to thin-provisioning for maximum space savings. |
VMstoreOnly - Since v310.11 | List<String> | void |
| PUT |
/v310/vm/updateReplicationConfigToDefault |
Update the outgoing replication configurations for the specified VMs to the system default replication configuration. |
All - Since v310.21 | List<String> - the selected Tintri UUIDs | void |
| PUT |
/v310/vm/updateScheduleToDefault |
Update selected VMs to use the default snapshot schedules. |
All | List<String> - the selected Tintri UUIDs | void |
| POST |
/v310/vm/vmListDownloadable |
Create a URL for retrieving the specified VM list report which is returned as output. |
TgcOnly | VirtualMachineDownloadableReportFilter - The filer for generating the report. | String - The URL that the user can use to retrieve the VM list report. |
| GET |
/v310/vm/{vmId} |
Return the virtual machine information specified in the URI. |
All | | VirtualMachine - VirtualMachine This includes basic information, latest historic statistics, replication configuration along with it's status |
| PUT |
/v310/vm/{vmId} |
Update VM properties apart from SnapshotSchedule and ReplConfig, like enabling or disabling replication at VM level. |
All | Request<VirtualMachine> - the vm container | void |
| PUT |
/v310/vm/{vmId}/affinity |
Updates virtual machine affinity rule. |
TgcOnly - Since v310.51 | VirtualMachineAffinityRule - the VirtualMachineAffinityRule to set. | void |
| GET |
/v310/vm/{vmId}/customizationScripts |
API to get customization scripts for the VM |
VMstoreOnly - Since v310.21 | | List<String> |
| PUT |
/v310/vm/{vmId}/hfSnapshotConfig |
Update the VM high frequency snapshot configuration properties |
All - Since v310.21 | Request<HighFrequencySnapshotConfig> - The High Frequency Snapshot Configuration | void |
| PUT |
/v310/vm/{vmId}/pin |
Operation will pin the VM to Flash storage in case of hybrid platform. |
VMstoreOnly - Since v310.21 | | void |
| PUT |
/v310/vm/{vmId}/qosConfig |
Update QoS per VM. |
All - Since v310.21 | Request<VirtualMachineQoSConfig> - the VirtualMachineQoSConfig Request | void |
| PUT |
/v310/vm/{vmId}/relocate |
Relocate a virtual machine to another datastore. |
All - Since v310.41 | VirtualMachineRelocateSpec | Task - Task object that can be used to track the progress of the operation. |
| DELETE |
/v310/vm/{vmId}/replicationConfig |
Deprecated. Delete all the incoming and custom outgoing replication configurations for a VM. |
VMstoreOnly | | void |
| POST |
/v310/vm/{vmId}/replicationConfig |
Deprecated. Create a new replication configuration for the VM. |
VMstoreOnly | VirtualMachineReplicationConfig - The new outgoing replication configuration, to be created for the specified VM | VirtualMachineReplicationConfig - VirtualMachineReplicationConfig object created for the specified VM |
| PUT |
/v310/vm/{vmId}/replicationConfig |
Deprecated. Deprecated since v310.61. |
VMstoreOnly | Request<VirtualMachineReplicationConfig> - the replication configuration | void |
| DELETE |
/v310/vm/{vmId}/replicationConfig/incoming |
Delete incoming replication configuration for a VM. |
VMstoreOnly - Since v310.61 | | void |
| DELETE |
/v310/vm/{vmId}/replicationConfig/{id} |
Deprecated. Delete a specific replication configuration for a VM. |
VMstoreOnly | | void |
| PUT |
/v310/vm/{vmId}/replicationConfigs |
Update the outgoing replication configurations for the VM specified by the given vmId to the new replication configurations, specified in the API input. |
All - Since v310.21 | List<VirtualMachineReplicationConfig> - List of VirtualMachineReplicationConfig objects, representing a new set of replication configurations to be applied to the VM. | void |
| POST |
/v310/vm/{vmId}/snapshotSchedule |
Create a new custom VM snapshot schedule |
All | VirtualMachineSnapshotSchedule - the snapshot schedule to be created. | VirtualMachineSnapshotSchedule |
| PUT |
/v310/vm/{vmId}/snapshotSchedule |
Update VM snapshot schedule properties |
All | Request<VirtualMachineSnapshotSchedule> - the snapshot schedule | void |
| DELETE |
/v310/vm/{vmId}/snapshotSchedule/{scheduleName} |
Delete a custom VM snapshot schedule |
All | | void |
| POST |
/v310/vm/{vmId}/statsDownloadable |
Create a URL for retrieving the specified VM historical statistics report which is returned as output. |
TgcOnly | VirtualMachineStatDownloadableReportFilter - The filer for generating the report. | String - The URL that the user can use to retrieve the historic VM statistics report. |
| GET |
/v310/vm/{vmId}/statsHistoric |
Gets the historic VM performance slice containing all of the statistics for the VM specified by query parameters. |
All | | Page - Paginated items contining a list of . |
| GET |
/v310/vm/{vmId}/statsRealtime |
Gets the real time VM performance slice containing all of the statistics for the VM. |
VMstoreOnly | | Page - Paginated items contining a list of . |
| PUT |
/v310/vm/{vmId}/unpin |
Un-pin VM from Flash storage in case of hybrid platform. |
VMstoreOnly - Since v310.21 | | void |
| GET |
/v310/vmstore |
Returns all VMstores and their properties in the Tintri Global Center cluster. |
TgcOnly | | List<VmStore> - All VMstores added to the cluster. |
| POST |
/v310/vmstore |
Add a VMstore to the Tintri Global Center cluster. |
TgcOnly | VmStore - The VMstore and its properties. | VmStore - VMstore with the new Tintri UUID assigned by the system. |
| POST |
/v310/vmstore/vmstoreListDownloadable |
Create a URL for retrieving the VMstore list report which is returned as output. |
TgcOnly | VMstoreDownloadableReportFilter - The filter for generating the report. | String - The URL that the user can use to retrieve the VMstore list report. |
| DELETE |
/v310/vmstore/{uuid} |
Deletes a VMstore by it's Tintri UUID. |
TgcOnly | | void |
| PUT |
/v310/vmstore/{vmStoreUuid} |
Updates the specified VMstore properties. |
TgcOnly | Request<VmStore> - The VMstore properties. | void |
| GET |
/v310/vmstorePool |
Return a list of all the VMstore pools in the Tintri Global Center. |
TgcOnly - Since v310.51 | | Page - Paginated items. |
| POST |
/v310/vmstorePool |
Create a new VMstore pool |
TgcOnly - Since v310.51 | VmstorePool - New VMstore pool to be created | VmstorePool - Newly created VMstore pool. |
| POST |
/v310/vmstorePool/vmPoolListDownloadable |
Create a URL for retrieving the specified VM Pool report which is returned as output. |
TgcOnly - Since v310.51 | VmstorePoolDownloadableReportFilter - VmstorePoolDownloadableReportFilter specifies the report name, the report fields, the report format, and start and end times for the report. | String - The output URL is used to download the report. |
| GET |
/v310/vmstorePool/{poolUuid} |
Return the VMstore pool associated with the specified ID |
TgcOnly - Since v310.51 | | VmstorePool - The VMstore pool if found else error message. |
| PUT |
/v310/vmstorePool/{poolUuid} |
Update the specified VMstore pool with the new configuration |
TgcOnly - Since v310.51 | VmstorePool - VMstore pool with new attribute values. | void |
| DELETE |
/v310/vmstorePool/{poolUuid} |
Delete the VMstore pool associated with the specified ID. |
TgcOnly - Since v310.51 | | void |
| PUT |
/v310/vmstorePool/{poolUuid}/members |
Add or delete members for the given VMstore pool. |
TgcOnly - Since v310.51 | CollectionChangeRequest - new and deleted members to be updated | void |
| GET |
/v310/vmstorePool/{poolUuid}/recommendation/current |
Returns the current Recommendation for a specified VMstorePool UUID. |
TgcOnly - Since v310.51 | | Recommendation - the Recommendation if found else error message. |
| GET |
/v310/vmstorePool/{poolUuid}/recommendation/{recoUuid} |
Returns the Recommendation associated with the specified Recommendation UUID. |
TgcOnly - Since v310.51 | | Recommendation - the Recommendation if found else error message. |
| PUT |
/v310/vmstorePool/{poolUuid}/recommendation/{recoUuid} |
Update one or more attributes of a Recommendation for the specified Recommendation UUID. |
TgcOnly - Since v310.51 | Request<Recommendation> - Request object that contains attribute and value to be updated. | void |
| POST |
/v310/vmstorePool/{poolUuid}/recommendation/{recoUuid}/accept |
Accept a Recommendation. |
TgcOnly - Since v310.51 | | void |
| POST |
/v310/vmstorePool/{poolUuid}/recommendation/{recoUuid}/acknowledge |
Acknowledge a Recommendation. |
TgcOnly - Since v310.51 | | void |
| POST |
/v310/vmstorePool/{poolUuid}/recommendation/{recoUuid}/cancel |
Cancel a Recommendation that has been accepted. |
TgcOnly - Since v310.51 | | void |
| PUT |
/v310/vmstorePool/{poolUuid}/recommendation/{recoUuid}/issues |
Select a subset of VMstores and/or issues. |
TgcOnly - Since 310.51 | List<RecommendationIssueSelection> - List of RecommenationType(s) to select. | void |
| POST |
/v310/vmstorePool/{poolUuid}/recommendation/{recoUuid}/reset |
Reset a Recommendation. |
TgcOnly - Since v310.51 | | void |
| GET |
/v310/vmstorePool/{poolUuid}/recommendationHistory |
Returns the Recommendation history for 30 days. |
TgcOnly - Since v310.51 | | List<Recommendation> - a list of Recommendations |