Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

REST API Resources

# REST API Resources

- Versions

- Jump To

Device Details

## Device Details

The Device Details category provides basic information about the devices in NCS :

- Device summary and inventory information about devices.
- The hierarchy of three kinds of groups: Device Type groups, Site groups, and User Defined groups.
- Events provides access to various events from the system.

Resource | Description
--- | ---
GET Inventory Details | It provides an aggregated view of all the available inventory information for the device.
GET 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 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 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 Syslogs | Represents the syslog view. Syslogs are standard method for logging messages such as system events in an IP network.

Group Summary Service

## 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
--- | ---
GET Device Groups | Deprecated Do not use this resource. Replaced by /op/groups/deviceGroups. This provides information about the hierarchy of device type groups. Note that internally to NCS, DeviceGroups are type of "Group", and thus all children will be of the generic type "subGroup".
GET Sites | Deprecated Do not use this resource. Replaced by /op/groups/sites. This provides information about the site groups and its hierarchy of campus and buildings. Note that internally to NCS, Sites are type of "Group", and thus all children will be of the generic type "subGroup".
GET User Defined Groups | 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 to NCS, UserDefinedGroups are type of "Group", and thus all children will be of the generic type "subGroup".

Report Service

## Report Service

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

Resource | Description
--- | ---
GET Run a Report | 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.
GET Get Available Report 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 | 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.

Statistics

## Statistics

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

Resource | Description
--- | ---
GET System Information | Retrieves system information statistics.
GET System Health | Retrieves system health statistics.
GET Application Performance | Retrieves the application performance statistics.
GET Applications Number of Users | Retrieves the number of users of an application.
GET Top N Application Hosts | Retrieves the top N application hosts.
GET Application Traffic Analysis | Retrieves the traffic analysis of an application.
GET Worst N Application Hosts | Retrieves the worst N application hosts.
GET Worst N Application Sites | Retrieves the worst N application sites.
GET Top N Device CPU Utilization | Retrieves the top N device CPU utilization statistics.
GET Top N Device Memory Utilization | Retrieves the top N device memory utilization statistics.
GET Top N Device Temperature | Retrieves the top N device temperature statistics.
GET Device Availability | Retrieves the device availability summary for a given IP address.
GET Device Availability Summary | Retrieves the device availability summary.
GET Device Availability Message | Retrieves the device availability message.
GET Device Down Message | Retrieves the device down message.
GET Device Reachability Status | Retrieves the device reachability status.
GET CPU Utilization Trend | Retrieves the device CPU utilization trend.
GET Memory Utilization Trend | Retrieves the device memory utilization trend.
GET CPU Utilization Summary | Retrieves the device CPU utilization summary.
GET Device Health Info | Retrieves the device health information.
GET Device Port Summary | Retrieves the device port summary.
GET Interface Availability | Retrieve the interface availability.
GET Interface Availability Summary | Retrieves the interface availability summary.
GET Interface Details | Retrieves the interface details.
GET Interface Errors | Retrieves the interface errors.
GET Interface Discards | Retrieves the interface discards.
GET Interface Utilizations | Retrieves the interface utilization.
GET Interface Utilization Summary | Retrieves the interface utilization summary.
GET Interface Status Summary | Retrieves the interface status summary.
GET Top N Interface Utilization | Retrieves the top N interface utilization statistics.
GET Top N Interface Errors | Retrieves the top N interface error statistics.
GET Top N WAN Interface Utilization | Retrieves the top N WAN interface utilization statistics.
GET Top N WAN Interface Issues | Retrieves the top N WAN interface issue statistics.
GET Top N Class Map QOS | Retrieves the top N class map QOS statistics.
GET Interface Availability Message | Retrieves the interface availability message.
GET Interface Down Message | Retrieves the interface down message.

Wireless Device Details

## Wireless Device Details

The Wireless Device Details category provides detailed information about the wireless devices in NCS.

Resource | Description
--- | ---
GET Wireless Lan Controller Summary | Represents summary information about a WLAN controller.
GET Wireless Lan Controller Details | Represents detail information about a WLAN controller.
GET Wireless Lan Controller Utlizations | Represents the latest CPU and memory utilization collected from a WLAN controller.
GET Historical Wireless Lan Controller Utlizations | Represents the historical CPU and memory utilization information collected from WLAN controllers in past 24 hours.
GET Wireless Access Point Summary | Represents a wireless access point including both unified and autonomous. It provides device attributes such as type, version, assoication controller, number of associated client, etc.
GET Wireless Access Point Details | Represents detail information of a wireless access points. It includes basic attributes, inventory, CDP, client and other information.
GET Radio Summary | Represents a radio interface of an wireless access point.
GET Lightweight AP Radio Details | Represents detail information of a radio interfaces on lightweight access point.
GET Autonomous AP Radio Details | Represents a radio interface of an autonomous access point.
GET Radio Interface Statistics | Represents the latest statistics information for radio interfaces of lightweight wireless access points collected from WLAN controllers.
GET Radio Interface 802.11 Counters | Represents the latest 802.11 counters for radio interfaces of lightweight wireless access points collected from controllers.
GET Historical Radio Interface Statistics in Last 24 Hours | 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 Radio Interface 802.11 Counters in Last 24 Hours | 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.
GET Client Summary | 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 Details | 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 | Represents detail view of client sessions. It provides device and session related attributes including security, connected device, session time, traffic, etc.
GET Client Statistics | Represents client statistics data collected during last polling cycle in NCS. The data represented here are the counters retrieved from controllers. The counters only get reset in new sessions.
GET Historical Client Statistics | 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.
GET Client Counts | Represents number of clients counted in NCS during last polling cycle. The combination of type, key and subtype represents number of clients associated with the entity.
GET Historical Client Counts | 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 Client Traffic Information | Represents clients traffic information collected during last polling cycle in NCS.
GET Historical Client Traffic Information | 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.