Cisco Cisco Prime Performance Manager 1.5 Developer's Guide

Page of 41
 
Cisco Prime Performance Manager1.5 REST API Guide 
Basic Authentication Scheme. 
 
That is,  when the Prime Performance Manager has user access enable, the 
REST API requests should be sent over an HTTPS connection. And the 
HTTP Authorization header should contain the text “Basic 
username:password”, where the “username:password” should be encoded 
according to the Base64 format.   
 
For example, if the user agent wishes to send user id “rubens” and password 
“r1b2ns”, it would Base64 encode the text “rubens:r1n2ns”.  And it would 
send the following header field: 
 
Header Key        |    Header Value 
Authorization     |    Basic cnViZW5zOnIxYjJucw== 
 
Format: 
 
Refer to section 2 RFC 2617 Basic Authentication Scheme. 
Additional Notes: 
 
Verify that this header is sent with the request if Prime Performance Manager has user access enabled 
 
The userId and password defined in the Prime Performance Manager server must be base64 encoded and 
added to the header as defined in the HTTP standards. 
5.10  HTTP Response Headers 
The following table shows the HTTP Response headers supported. 
Table 35 – HTTP Response Headers 
Header Name 
Sample Value 
Description 
Allow 
(HTTP/1.1) 
For example, “GET” 
This header is generated along with 
status code “405” in response to 
request with a method (HEAD, 
POST, PUT, DELETE) that is not 
supported for that resource. 
Cache-Control 
(HTTP/1.1) 
For example, “no-cache” OR “max-age=3600” 
When “no-cache” is found, the client 
should not cache the response.  
Otherwise if max-age is found, 
response can be cached by the client. 
The max-age value tells the client 
how long in seconds the response 
should be cached. 
Content-Type 
For example. “application/xml;charset=UTF-8” 
The content-type of the response 
followed by the charset encoding. 
Date 
For example. “Date    Fri, 27 Jan 2012 20:29:02 
GMT” 
The date the response was created. 
WWW-Authenticate 
“Basic realm=RESTSecureArea” 
This header is sent back to the client 
when Prime Performance Manager 
has user access (authentication) 
enabled, and the system failed to 
authenticate the user’s request (see