ViPR 2.2 - Access the ViPR REST API

Table of Contents

ViPR Rest API access

The ViPR REST API is accessible using any web browser or programming platform that can issue HTTP requests.

Using a web browser you would first authenticate with the ViPR REST API by typing:

Request
https://<ViPR_VIP>:4443/login?using-cookies
Response
<loggedIn>
     <user>root</user>
</loggedIn>

Once the browser is authenticated with the ViPR REST API, you can send other GET requests, such as a request to retrieve the tenant of the current user.

Request
https://<ViPR_VIP>:4443/tenant
Response
<tenant_info>
     <name>Provider Tenant</name>
     <link rel="self" href="/tenants/urn:storageos:TenantOrg:2b5f6d7c-e670-4aee-9fc1-ddbf0fc8de22:global"/>
     <id>urn:storageos:TenantOrg:2b5f6d7c-e670-4aee-9fc1-ddbf0fc8de22:global</id>
</tenant_info>

To issue POST, PUT, and DELETE HTTP requests from a web browser, you need browser plugins, such as Internet Explorer's httpAnalyzer. Most major browsers, such as Firefox and Chrome, have a poster plugin that will allow you to call HTTP commands directly from your browser.

You can also access the REST API using scripting platforms such as curl and perl. EMC also provides a Java client that wraps the ViPR REST API calls in a set of Java classes.

Back to Top

REST API Ports

The ViPR REST API uses two different ports.

The following table show the services available on each of the two ports used by the ViPR REST API.

Back to Top