Cisco Cisco Prime Performance Manager 1.7 Developer's Guide
Cisco Prime Performance Manager 1.7 REST API Guide
structure that is easier to traverse than the previous version.
Example to select the JSON version 2 (simpler JSON format):
Accept=application/vnd.cisco.ppm+json;v=2
Example to select PDF from the Accept header:
Accept=application/pdf
Example to select CSV:
Accept=application/pdf;q=0.5, text/csv;q=0.8
Example to select JSON v2
Accept= application/pdf;q=0.5, text/csv;q=0.8,
application/vnd.cisco.ppm+json;v=2
Example to select the JSON version 2 (simpler JSON format):
Accept=application/vnd.cisco.ppm+json;v=2
Example to select PDF from the Accept header:
Accept=application/pdf
Example to select CSV:
Accept=application/pdf;q=0.5, text/csv;q=0.8
Example to select JSON v2
Accept= application/pdf;q=0.5, text/csv;q=0.8,
application/vnd.cisco.ppm+json;v=2
Additional Notes:
The outputType query string parameter overrides the Accept header.
A 406 error status code is returned for an Accept header not supported by the REST API.
5.9.2 Authorization
Table 43 – Authorization HTTP header
Header Name
Notes
Authorization
This request header should be sent to the REST API when the underlying
Prime Performance Manager server has user access enabled. The REST API
follows the HTTP Basic Authentication Scheme standards.The specifics of
how this header should be formatted are defined in the RFC 2616 HTTP 1.1
standards – section 14.8 Authorization of RFC 2616, and in the RFC 2617
HTTP Authentication: Basic and Digest Access Authentication – section 2
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.
Prime Performance Manager server has user access enabled. The REST API
follows the HTTP Basic Authentication Scheme standards.The specifics of
how this header should be formatted are defined in the RFC 2616 HTTP 1.1
standards – section 14.8 Authorization of RFC 2616, and in the RFC 2617
HTTP Authentication: Basic and Digest Access Authentication – section 2
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.
added to the header as defined in the HTTP standards.
5.10 HTTP Response Headers
The following table shows the HTTP Response headers supported.