HP 3PAR Web Service API 1.3.1 Developer's Guide

Creating a Session Key
Except when querying the API version and when creating and deleting a session key, the session
key is required for all operations and is passed in an HTTP header with the name
X-HP3PAR-WSAPI-SessionKey.
Each session key is associated with the IP address of the client that originally requested it, and
subsequent use is restricted to requests from that same IP address. An example of creating a session
key using cURL (a command-line utility available for most Linux distributions) is as follows:
1. Enter the following (in a single command line):
curl -k -H "Accept:application/json" -H
"Content-Type:application/json" --data-binary
'{"user":"example","password":"example"}'
https://<storage_system>:8080/api/v1/credentials
2. The system returns the HTTP code 201 Created, the URI of the newly created session key
in the Location portion of the HTTP header, and a message body with the JSON object;
see Table 8 (page 39).
Example
HTTP/1.1 201 Created
Date: Thu, 28 Jul 2011 00:00:38 GMT
Server: hp3par-wsapi
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/json
Location: /api/v1/credentials/48A70B8A8301C458037E0821
Connection: close
{"key":"48A70B8A8301C458037E0821"}
Table 8 Message Body JSON Objects for Session Key Creation
DescriptionJSON TypeMember
The session key.stringkey
Using a Session Key
Except for creating and deleting a session key, the session key is required for all operations. The
key is passed in an HTTP header with the following name:
X-HP3PAR-WSAPI-SessionKey
Example using the cURL command line utility
curl -s –H "X-HP3PAR-WSAPI-SessionKey: 48A70B8A8301C458037E0821" \
http://InServ1:8008/api/v1/volumes
The resulting HTTP request appears as follows:
GET /api/v1/volumes HTTP/1.1
User-Agent: curl/7.21.3 (i686-pc-linux-gnu) libcurl/7.21.3
OpenSSL/0.9.8ozlib/1.2.3.4 libidn/1.18
Host: InServ1:8008
Accept: */*
X-HP3PAR-WSAPI-SessionKey: 48A70B8A8301C458037E0821
Supported JSON sub-objects for the Accept: */* header are shown in Table 2 (page 16).
System Access 39