Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

REST API Resources

Clients

Provides information about wired and wireless clients.

Resource Description API Version
GET Client Counts

GET data/ClientCounts

Represents number of clients counted during the last polling cycle. The combination of type, key and subtype represents number of clients associated with the entity.
GET Client Details

GET data/ClientDetails

Represents the detail view of a client. It provides attributes of client device, security information, connected device, traffic and session information. All information is collected in current or last session.
GET Client Sessions

GET data/ClientSessions

Represents detail view of client sessions. It provides device and session related attributes including security, connected device, session time, traffic, etc.
GET Client Summary

GET data/Clients

Represents client view with information about the end points. It provides end point information such as MAC address, IP address, username, and status.
GET Client Traffic Information

GET data/ClientTraffics

Represents clients traffic information collected during the last polling cycle.
GET Historical Client Counts

GET data/HistoricalClientCounts

Represents client count collected in last 24 hours with 5 minutes (default) interval. The dataset could be really big. When querying, you must use paged query or filtered by entity or time. Otherwise it could result in longer running query to affect system performance.
GET Historical Client Traffic Information

GET data/HistoricalClientTraffics

Represents client traffic information collected in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying, you must use paged query or filtered by entity or time. Otherwise it could be resulted in longer running query to affect system performance.

Credentials Service

A REST based operation to query the Credential Manager for a device's credentials.

Resource Description API Version
GET Credentials

GET op/cm/credentials

Operation to retrieve device credentials. Can take one of two parameters: 'id' or 'address'. , e.g. ?id=17010 or ?address=172.23.218.75, where the id is MEI ID or the address is the management address.

Device Details

The Device Details category provides basic information about the managed devices:
  • Device summary and inventory information about devices.
  • Events and alarms in the system.
Resource Description API Version
GET Alarms

GET data/Alarms

Alarm is a representation of the fault or change of state that occurred in the managed system; it could be resource or service and customer related. Alarms are associated with a group of events received from the managed resources, usually with the same source and category, indicating that such fault or event had occurred.
GET Devices

GET data/Devices

Represents the device view with information about the managed network elements. It provides device information such as device name, device type, ip address, software type, version, and also provides the reachability and management status.
GET Events

GET data/Events

Represents a "normalized" record of an occurrence reported by the network (or any system capable of notifying of such an occurrence); it could be a syslog, SNMP trap, or any other such type. The term "normalized" denotes a single format abstracted over all types of reported events, regardless of source and structure.
GET Inventory Details

GET data/InventoryDetails

It provides an aggregated view of all the available inventory information for the device.
GET Syslogs

GET data/Syslogs

Represents the syslog view. Syslogs are standard method for logging messages such as system events in an IP network. This API only supports Syslogs with severities 0, 1, 2 (Emergency, Alert, Critical)

Group Summary Service

The Group Summary Service provides a summary of alarms per group for each type of group (Site, Device Type or User Defined Group) , an overall alarm summary and a summary of the number devices per Site.

Resource Description API Version
GET Device Groups

GET data/DeviceGroups

Deprecated

Do not use this resource. Replaced by /op/groups/deviceGroups.

This provides information about the hierarchy of device type groups. Note that internally, DeviceGroups are type of "Group", and thus all children will be of the generic type "subGroup".
GET Sites

GET data/Sites

Deprecated

Do not use this resource. Replaced by /op/groups/sites.

This provides information about the location groups and its hierarchy of campus and buildings. Note that internally, Locations are type of "Group", and thus all children will be of the generic type "subGroup".
GET User Defined Groups

GET data/UserDefinedGroups

Deprecated

Do not use this resource. Replaced by /op/groups/userDefinedGroups.

Provides the list of User Defined groups and the associated sub group hierarchy. Note that internally, UserDefinedGroups are type of "Group", and thus all children will be of the generic type "subGroup".

Report Service

The Report service provides operations to discover and run reports. Reports need to be defined in the system prior to access through the API.

Resource Description API Version
GET Get Available Report Templates

GET op/reportService/templates

This URL is used to get all the saved report templates. It returns an array of information about the available saved report templates.

Report templates need to be set up in the GUI to be available here.

GET Get a Report

GET op/reportService/getReport

This URL is used to retrieve the report data for a report that was previously generated from an asynchronous call of the reportService/report URL, or returns the latest result from a scheduled report generation.

The pageIndex request parameter can be specified to request a particular page. The pageCount response parameter can be used to identify how many total pages the report has.

GET Run a Report

GET op/reportService/report

Deprecated

This resource does not support large report datasets. Please use the reportService/zipReport-GET or reportService/getReport-GET resources.

This URL is used to generate reports from a specific saved report template and return the report output as an XML/JSON response.

It takes two arguments: a String reportTitle - a unique title of the saved report template, and a Boolean async indicating if the call is asynchronous when the value is true.

It provides the report data in the case of a synchronous call, or just provides a report URL using which the latest report can be retrieved.

Statistics

The Statistics services provide summary, pre-defined statistical information about the system.

Resource Description API Version
GET Application Art Analysis

GET op/statisticsService/application/applicationArtAnalysis

Retrieves the application art analysis statistics in the list of time, client network time, server response time, transaction time and data time. Here are the sample queries
  • /op/statisticsService/application/applicationArtAnalysis -- return the art analysis statistics of all applications in the past 1 hour
  • /op/statisticsService/application/applicationArtAnalysis?networkAwareType=2 -- return the wired network art analysis statistics of all applications
  • /op/statisticsService/application/applicationArtAnalysis?appId=1234,5678&siteId=10013 -- return the art analysis statistics of the application with id 1234 and 5678 in the site 10013
GET Application Performance

GET op/statisticsService/application/performance

Retrieves the application performance statistics.
GET Application Top N Traffics

GET op/statisticsService/application/topNTraffics

Retrieves the top N clients or server traffic statistics of an application or all applications. Here are the sample queries
  • /op/statisticsService/application/topNTraffics -- return the top 15 client traffics of all applications in the past 1 hour
  • /op/statisticsService/application/topNTraffics?nodeType=server -- return the top 15 server traffics of all applications in the past 1 hour
  • /op/statisticsService/application/topNTraffics?networkAwareType=2 -- return the top 15 client wired traffics of all applications in the past 1 hour
  • /op/statisticsService/application/topNTraffics?appId=1234 -- return the top 15 client traffics of the application with id 1234 in the past 1 hour
  • /op/statisticsService/application/topNTraffics?appId=1234,5678 -- return the top 15 client traffics of of the application with id 1234 and 5678 in the past 1 hour
GET Application Traffic Analysis

GET op/statisticsService/application/trafficAnalysis

Retrieves the traffic analysis of an application.
GET Application Volume

GET op/statisticsService/application/appVolume

Retrieves the application statistics as a list of pairs: application name and statistic value. The statistic value can be a rate(bytes/second) or volume(bytes). To choose a statistic type you should use the parameter "dataType". The default type is volume. Here are the sample queries:
  • /op/statisticsService/application/appVolume -- return top 15 application volumes in the past 1 hour
  • /op/statisticsService/application/appVolume?siteId=1234
  • /op/statisticsService/application/appVolume?deviceIp=192.168.1.1
  • /op/statisticsService/application/appVolume?deviceIp=192.168.1.1&interfaceIndex=2
  • /op/statisticsService/application/appVolume?dataType=rate
GET Applications Number of Users

GET op/statisticsService/application/numberOfUsers

Retrieves the number of users of an application.
GET CPU Utilization Summary

GET op/statisticsService/device/cpuUtilSummary

Retrieves the device CPU utilization summary.
GET CPU Utilization Trend

GET op/statisticsService/device/cpuUtilTrend

Retrieves the device CPU utilization trend.
GET Device Availability

GET op/statisticsService/device/availability

Retrieves the device availability summary for a given IP address.
GET Device Availability Message

GET op/statisticsService/device/availabilityMessage

Retrieves the device availability message.
GET Device Availability Summary

GET op/statisticsService/device/availabilitySummary

Retrieves the device availability summary.

GET Device Down Message

GET op/statisticsService/device/downMessage

Retrieves the device down message.
GET Device Health Info

GET op/statisticsService/device/healthInfo

Retrieves the device health information.
GET Device Port Summary

GET op/statisticsService/device/portSummary

Retrieves the device port summary.
GET Device Reachability Status

GET op/statisticsService/device/reachabilityStatus

Retrieves the device reachability status.
GET Interface Availability

GET op/statisticsService/interface/availability

Retrieve the interface availability.
GET Interface Availability Message

GET op/statisticsService/interface/availMessage

Retrieves the interface availability message.
GET Interface Availability Summary

GET op/statisticsService/interface/availabilitySummary

Retrieves the interface availability summary.
GET Interface Details

GET op/statisticsService/interface/details

Retrieves all details for a specific interface.
GET Interface Discards

GET op/statisticsService/interface/discards

Retrieves the interface discards.
GET Interface Down Message

GET op/statisticsService/interface/downMessage

Retrieves the interface down message.
GET Interface Errors

GET op/statisticsService/interface/errors

Retrieves the interface errors.
GET Interface Status Summary

GET op/statisticsService/interface/statusSummary

Retrieves the interface status summary.
GET Interface Utilization Summary

GET op/statisticsService/interface/utilSummary

Retrieves the interface utilization summary.
GET Interface Utilizations

GET op/statisticsService/interface/util

Retrieves the interface utilization.
GET Memory Utilization Trend

GET op/statisticsService/device/memoryUtilTrend

Retrieves the device memory utilization trend.
GET System Health

GET op/statisticsService/system/health

Retrieves system health statistics.
GET System Information

GET op/statisticsService/system/info

Retrieves system information statistics.
GET Top N Application Hosts

GET op/statisticsService/application/topNHosts

Retrieves the top N application hosts.
GET Top N Class Map QOS

GET op/statisticsService/interface/topNClassMapQOS

Retrieves the top N class map QOS statistics.
GET Top N Device CPU Utilization

GET op/statisticsService/device/topNCPU

Retrieves the top N device CPU utilization statistics.
GET Top N Device Memory Utilization

GET op/statisticsService/device/topNMemory

Retrieves the top N device memory utilization statistics.
GET Top N Device Temperature

GET op/statisticsService/device/topNTemp

Retrieves the top N device temperature statistics.
GET Top N Interface Errors

GET op/statisticsService/interface/topNErrors

Retrieves the top N interface error statistics.
GET Top N Interface Utilization

GET op/statisticsService/interface/topNUtil

Retrieves the top N interface utilization statistics.
GET Top N WAN Interface Issues

GET op/statisticsService/interface/topNWanIssues

Retrieves the top N WAN interface issue statistics.
GET Top N WAN Interface Utilization

GET op/statisticsService/interface/topNWanUtil

Retrieves the top N WAN interface utilization statistics.
GET Worst N Application Hosts

GET op/statisticsService/application/worstNHosts

Retrieves the worst N application hosts.
GET Worst N Application Locations

GET op/statisticsService/application/worstNSites

Retrieves the worst N application sites.

Wireless Device Details

The Wireless Device Details category provides detailed information about the managed wireless devices.
Resource Description API Version
GET Autonomous AP Radio Details

GET data/AutoApRadioDetails

Represents a radio interface of an autonomous access point.
GET Client Statistics

GET data/ClientStats

Represents client statistics data collected during the last polling cycle. The data represented here are the counters retrieved from controllers. The counters only get reset in new sessions.
GET Historical Client Statistics

GET data/HistoricalClientStats

Represents client statistics collected in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying it, it is better to use paged query or filtered by client or time.
Represents 802.11 counters collected for radio interfaces of lightweight wireless access points in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying it, it is better to use paged query or filtered by AP or time.
Represents statistics for radio interfaces of lightweight wireless access points collected in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying it, it is better to use paged query or filtered by AP or time.
GET Historical Wireless Lan Controller Utlizations

GET data/HistoricalWLCUtilizations

Deprecated

Do not use this resource. Replaced by /data/HistoricalWLCCPUUtilizations and /data/HistoricalWLCMemUtilizations.

Represents the historical CPU and memory utilization information collected from WLAN controllers in past 24 hours.
GET Lightweight AP Radio Details

GET data/RadioDetails

Represents detail information of a radio interfaces on lightweight access point.
Represents the latest 802.11 counters for radio interfaces of lightweight wireless access points collected from controllers.
Represents the latest statistics information for radio interfaces of lightweight wireless access points collected from WLAN controllers.
GET Radio Summary

GET data/Radios

Retrieves radio interfaces of lightweight and autonomous access points. You should use RadioDetails API for retrieving only radio interfaces of lightweight APs and AutoApRadioDetails API for only radio interfaces of autonomous APs.
GET Wireless Access Point Details

GET data/AccessPointDetails

Represents detail information of a wireless access points. It includes basic attributes, inventory, CDP, client and other information.
GET Wireless Access Point Summary

GET data/AccessPoints

Represents a wireless access point including both unified and autonomous. It provides device attributes such as type, version, association controller, number of associated client, etc.
GET Wireless Lan Controller Details

GET data/WlanControllerDetails

Represents detail information about a WLAN controller.
GET Wireless Lan Controller Summary

GET data/WlanControllers

Represents summary information about a WLAN controller.
GET Wireless Lan Controller Utlizations

GET data/WLCUtilizations

Deprecated

Do not use this resource. Replaced by /data/WLCCPUUtilizations and /data/WLCMemoryUtilizations.

Represents the latest CPU and memory utilization collected from a WLAN controller.