HP OneView REST API Reference

REST API Request Headers
stdreqhdrs.html[10/17/2013 10:36:09 AM]
HP OneView REST API Reference
REST API Request Headers
Name Requirements Usage
X-API-
Version
Required (unless otherwise noted in
the documentation)
NOTE: The requests documented in
the HP OneView REST API Reference
and REST API scripting chapter
correspond to a versionNumber of 3.
Requests specifying API version 3
always provide the behavior
documented here. Future API
changes will introduce higher version
numbers.
X-API-Version:[api-
version]
The OneView API version that the
client is requesting. If not
provided, the X-API-Version
value is automatically set to the
first version of the APIs. which is
not likely the desired version. This
header is REQUIRED in order to
ensure expected behavior.
The only supported value is X-
API-Version:3. An unsupported
API version returns a 412
response code (Precondition
Failed).
auth
Required
NOTE: The auth header is not
required in the following cases:
POST operation to obtain a
session token.
/rest/login-sessions
GET operation to download a
support dump.
/rest/appliance/support-
dumps/{filename}
GET operation to obtain the API
version supported by the
appliance.
/rest/version
auth:session-token
Session authorization token
obtained from the rest/login-
sessions API.
If this header is not included, or if
the session-token is invalid,
the response code is 401
(Unauthorized).
Accept
Optional
Accept:[media-type]
The requested data format to be
returned in the Response Body.