This REST API reference is for those interested in developing automation workflows and other applications using Tintri VMstore. This document explains how developers can leverage REST APIs over HTTP.

API Version

General Information

SSL only

Tintri requires that all requests are done over SSL. All requests to port 80 are converted to port 443 for VMstore.

UTF-8 Encoding

All strings passed to and from the Tintri APIs need to be UTF-8 encoded.

API Compatibility

Over time, the Tintri APIs will change. Future versions may add new managed entities or keys. To keep older clients working, the behavior and return values with given parameters will not change from the documented behavior except for undocumented request parameters or additional response keys.

With this in mind, clients should avoid passing undocumented parameters and accept keys that are not currently documented. API clients will have to be modified to obtain new Tintri features.

From TXOS and TGC 5.6.0.1 and onward, older API versions below v310.101 are deprecated.

API version v310.191 and newer support IPv6 address. To use IPv6 address, the client must login and set the the RestApiCredentials.fullApiVersion to v310.191 or later. Otherwise, the API will only support IPv4 address.

From TXOS and TGC 5.6.0.1 and onward, only TLSv1.2 is supported.

When an API error occurs, TintriError is returned. An example is below:

RBAC

New users can be created. Each user when created is assigned a role. Currently, the roles are:

The Read Only role is only allowed to read resources from the Tintri Appliance. This means that all GET APIs are allowed.

The System Admin role is the Read Only role plus updating and creating resources except for user management. This means that all GET, PUT, POST DELETE APIs are allowed except the user management DELETE, POST and PUT APIs.

The Admin role is the System Admin role plus updating and creating user management. This means that all GET, POST, PUT, and DELETE APIs are allowed.

The admin user is a special user that cannot be deleted or modified.

The DBA role extends the System Admin role, plus the operation for the database managed objects and operations.

The Data Protection Admin (DPA) role extends the System Admin role, plus the privilege to lock/unlock snapshots, update snapshot schedules, and modify protection policies associated with locked snapshot schedules.

The Data Protection Escalation Admin (DPEA) role extends the System Admin role, plus the operation to escalate the privilege of DPA user to perform restricted operations related to Lock Snapshot feature.

The dpea-user is a special user that is auto created when the Lock Snapshot feature is enabled for the first time. This user cannot be deleted or modified.

Filters

Filtering parameters are based on RFC 6570.

Pagination

Many of the Tintri APIs with GET methods return large numbers of objects. For the convenience of the client, a paged response is provided. The paged response is in the form of a Page object which is composed as follows:

Session Login

Session login uses the session resource. An HTTP POST with the user name, password, and role is sent. A session cookie is returned and this cookie is used in all subsequent API invocations.

URL structure

https://ttvm38.tintri.com/api/v310/session/login

Method

POST

Body

{"username":"admin",
 "typeId":"com.tintri.api.rest.vcommon.dto.rbac.RestApiCredentials",
 "password":"mypass",
 "fullApiVersion":"v310.191"}

Returns

HTTP status 200.
User role name

Session Logout

Session logout uses the session resource. An HTTP GET is used with the session cookie provided in the session login.

URL structure

https://ttvm38.tintri.com/api/v310/session/logout

Method

GET

Returns

HTTP status 204

Updating

Request allows for multiple properties of multiple objects to be updated at one time. The example below shows the JSON for updating the acceptIncomingTraffic property in DatastoreReplicationPath.

URL structure

https://ttvm38.tintri.com/api/v310/datastore/default/replicationInfo

Method

PUT

Body

{'typeId': 'com.tintri.api.rest.v310.dto.Request',
 'objectsWithNewValues':
    [{'typeId': 'com.tintri.api.rest.v310.dto.domain.beans.repl.DatastoreReplicationPath'
      'acceptIncomingTraffic': 'False'
     }],
 'propertiesToBeUpdated': ['acceptIncomingTraffic']
}

Returns

HTTP status 204.

MultipleSelectionRequest allows for multiple properties on one object for multiple resources at one time. The example below shows the JSON for updating the minNormalizedIops and minNormalizedIopsproperties in VirtualMachineQoSConfig for the API update QOS config.

URL structure

https://ttvm38.tintri.com/api/v310/vm/qosConfig

Method

PUT

Body

{'typeId': 'com.tintri.api.rest.v310.dto.MultipleSelectionRequest',
 'ids':
    ['A1D88A8A-8904-1E35-9DC2-589C317D31A6-VIM-00000000000001A5',
     'A1D88A8A-8904-1E35-9DC2-589C317D31A6-VIM-0000000000000070'
    ]
 'newValue':
    {'minNormalizedIops': '100',
     'maxNormalizedIops': '248',
     'typeId': 'com.tintri.api.rest.v310.dto.domain.beans.vm.VirtualMachineQoSConfig'
    }
 'propertyNames': ['minNormalizedIops', 'maxNormalizedIops']
}

Returns

HTTP status 204.

New APIs for v310.91

New APIs for v310.121

New APIs for v310.141

New APIs for v310.171

New APIs for v310.183

New APIs for v310.191

Resources

The API resources are presented below. The Data Overview button presents the Data Transfer Objects (DTOs) that are transferred between the Tintri server and the client. The API Overview and API Index buttons present different views of the API endpoints. To use the endpoints in a browser or a tool like Postman, the Tintri server and /api need to prefix the endpoints presented below; for example: http://vmstore.tintri.com/api/v310/vm