Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

REST API Resources

CLI Template Configuration

The CLI Template Configuration service allows a CLI configuration template to be applied to one or more target devices. It also provides a way to upload, delete, and get the CLI templates in the system.

Resource Description API Version
DELETE Delete Configuration Template

DELETE op/cliTemplateConfiguration/deleteTemplate

Deletes a template from the system.
GET Download Configuration Template

GET op/cliTemplateConfiguration/download

Deprecated

Please use the CLI Configuration Templates resource instead. This operation may be removed in a future release.

Export a template from the system.
GET List Configuration Templates

GET op/cliTemplateConfiguration/templates

Deprecated

This operation does not support pagination, filtering, or sorting. Please use the CLI Configuration Templates resource instead. This operation may be removed in a future release.

Get a list of the published Templates
GET List Device Types

GET op/cliTemplateConfiguration/deviceTypes

Returns the list of device types you can specify for a CLI template.
POST Upload Configuration Template

POST op/cliTemplateConfiguration/upload

Upload a new template into the system. Does not support Converged Access Templates (IOS-XE templates and templates created from them).
PUT Deploy Configuration Template

PUT op/cliTemplateConfiguration/deploy

Deprecated

This resource deploys templates in a synchronized way which may take a long time to respond. Use the resource Deploy Configuration Template Through Job instead

Deploy a template to a list of devices.
  • Does not support ports selection for the 'Ports' type templates.
  • Does not uptick deploy count.

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 Alarm Summary

GET op/groups/alarmSummary

Provides alarm summary information including: total number of alarms, number of alarmed devices, number of alarmed sites, number of alarmed APs and number of clients associated with the alarmed APs. Does not count cleared alarms.
GET Device Groups

GET op/groups/deviceGroups

Returns list of Device Type groups, including the count of alarms of each severity for each group.
GET Location Groups

GET op/groups/sites

Returns list of Locations, including the count of alarms of each severity for each group. Also includes counts of devices, APs and Clients associated with the Location and also location information regarding the location. This service was formerly known as "Site Groups."

This operation returns groups explicitly or implicitly assigned to your active virtual domain. Explicit groups have been created or later added to your active virtual domain (or were a child group of a group added to your active virtual domain). Implicit groups are groups with a close relation to an explicit group, for example, parents of explicit groups.

GET User Defined Groups

GET op/groups/userDefinedGroups

Returns list of User Defined groups for both Network Device Groups and Port Groups, including the count of alarms of each severity for each group.

This operation returns groups explicitly or implicitly assigned to your active virtual domain. Explicit groups have been created or later added to your active virtual domain (or were a child group of a group added to your active virtual domain). Implicit groups are groups with a close relation to an explicit group, for example, parents of explicit groups.

Note that Port Groups do not support virtual domain based filtering. You will be allowed to modify a Port group, even if it is implicitly assigned to your active virtual domain.

Manage and Monitor Info Service

The Manage and Monitor Info Service service provides information about the application and the server it runs on.

Resource Description API Version
GET Core Dumps

GET op/info/coredumps

Returns the number of application core dumps present on the server.
GET Disk Usage and Capacity

GET op/info/disk

Returns capacity and usage information for the volumes present on the application's server.
GET Licenses

GET op/info/license

Returns license information about the application.
GET Uptime

GET op/info/uptime

Returns uptime information as well as information about the application and the server it runs on.
GET Version

GET op/info/version

Returns the version of the application.