Cisco Cisco Videoscape Voyager Vantage 3.3 User Guide
19
Cisco Systems, Inc.
www.cisco.com
REST APIs
Vantage JSON Diagnostics uses two REST-compliant Web Service APIs to retrieve diagnostic information:
A Public REST API is a simple HTTP server in the headend that is used to request on-screen diagnostics and the
current diagnostic log file from an HTTP client in each set-top. This API supports the pull aggregation method.
current diagnostic log file from an HTTP client in each set-top. This API supports the pull aggregation method.
A Private REST API is a simple HTTP server in each set-top that is used to deliver error or log text to a designated
HTTP client in the headend. This API supports the push aggregation method.
HTTP client in the headend. This API supports the push aggregation method.
This section describes both APIs in detail.
Public REST API
The Public REST API allows external data collectors (clients) to retrieve diagnostic screen and error log data in JSON
format. This is a read-only API with simple or no authentication, depending on configuration (see Configuration for
details).
format. This is a read-only API with simple or no authentication, depending on configuration (see Configuration for
details).
Note:
The statistics data collected by the private API is available to the public API except through the log file retrieval.
General Syntax
HTTP GET {url} {parameter 1 & . . . parameter n}
Where url is a supported URL, and may be followed by one or more optional parameters concatenated by the ampersand
(&) character. The supported URLs and optional parameters are described below.
(&) character. The supported URLs and optional parameters are described below.
Supported URLs
Table 1
URLs for Public REST API
URL
Supported Parameters
Description
/diagnostics/osd/pages
format, datatype, path, category,
subcategory, pagenum, title
subcategory, pagenum, title
Diagnostic screen data, delivered in
JSON (or optional plain text) format.
Options give the ability to retrieve a
specific page or all pages of data.
JSON (or optional plain text) format.
Options give the ability to retrieve a
specific page or all pages of data.
/diagnostics/logs/module
name, begintime, endtime
Error report data for the specified
module.
module.
The Name is from the JavaScript
client (and would include vod or ppv)
or from dlog. All log data is stored in
the file in JSON format.
client (and would include vod or ppv)
or from dlog. All log data is stored in
the file in JSON format.