Cisco Cisco Prime Performance Manager 1.5 Developer's Guide
Cisco Prime Performance Manager1.5 REST API Guide
1 Purpose
This document describes the Cisco Prime Performance Manager Representational State Transfer (REST)
API used to retrieve network/node level, dashboard and aggregated group reporting data from the Prime
Performance Manager. The REST API is implemented as a web service front-end component on the
Prime Performance Manager gateway. The API allows applications to retrieve performance data from the
gateway using HTTP(s) GET requests using the URIs (Uniform Resource Identifier) specified in this
document.
API used to retrieve network/node level, dashboard and aggregated group reporting data from the Prime
Performance Manager. The REST API is implemented as a web service front-end component on the
Prime Performance Manager gateway. The API allows applications to retrieve performance data from the
gateway using HTTP(s) GET requests using the URIs (Uniform Resource Identifier) specified in this
document.
The data provided by the REST API can be in text format as XML (eXtensible Markup Language), JSON
(JavaScript Object Notation), CSV (Comma Separated Value), image format as PNG (Portable Network
Graphics), JPEG (Joint Photographic Experts Group), or PDF (Portable Document Format).
(JavaScript Object Notation), CSV (Comma Separated Value), image format as PNG (Portable Network
Graphics), JPEG (Joint Photographic Experts Group), or PDF (Portable Document Format).
The report response format is chosen based on the request HTTP Accept Header or the value of the
outputType query string parameter. If no specific data type is provided in either the HTTP Accept
Header or in the outputType query string, the reporting data returned from the REST API defaults to
the CSV text format.
outputType query string parameter. If no specific data type is provided in either the HTTP Accept
Header or in the outputType query string, the reporting data returned from the REST API defaults to
the CSV text format.
2 Assumptions
2.1 Audience
This document is intended for developers who wish to implement the network management RESTFul
client to consume performance reporting data from the Prime Performance Manager application. The
audience is assumed to be familiar with RESTful web services and the HTTP protocol.
client to consume performance reporting data from the Prime Performance Manager application. The
audience is assumed to be familiar with RESTful web services and the HTTP protocol.
2.2 HTTP Version
The Reports REST API embraces several aspects of the HTTP standards, including some HTTP headers,
verbs, and status codes. The REST API uses status codes that are only supported in the HTTP/1.1 version.
Therefore, it is expected that the client consuming this API complies with these HTTP/1.1 features.
verbs, and status codes. The REST API uses status codes that are only supported in the HTTP/1.1 version.
Therefore, it is expected that the client consuming this API complies with these HTTP/1.1 features.
2.3 SSL and HTTP
This API is served over an HTTPs secure connection when the Prime Performance Manager server has
SSL installed and enabled. In this case the client side must support the HTTP/SSL protocol and have the
Prime Performance Manager SSL public certificate installed on the client’s thrust store file.
SSL installed and enabled. In this case the client side must support the HTTP/SSL protocol and have the
Prime Performance Manager SSL public certificate installed on the client’s thrust store file.
2.4 Read Only API
This REST API is used for reading network performance reporting data. It supports the HTTP GET
method which does not affect the state of the resource being queried in the server.
method which does not affect the state of the resource being queried in the server.
2.5 Versioning
The Prime Performance Manager Reports REST API complies with the following versioning rule:
elements can be added when releasing a new version, but they may never be removed. A new release of
this API is expected to be downward compatible with a previous version. An older version of this Reports
REST API might appear to the client as if some elements were removed.
elements can be added when releasing a new version, but they may never be removed. A new release of
this API is expected to be downward compatible with a previous version. An older version of this Reports
REST API might appear to the client as if some elements were removed.