Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

REST API Resources

AAA/TACACS+ Servers Operations Service

Provides services manage AAA servers used by the appliance.

Resource Description API Version
DELETE Delete Server

DELETE op/aaa/tacacsPlusServer

Delete existing TACACS+ server
GET List Servers

GET op/aaa/tacacsPlusServer

Read all TACACS+ servers
POST Add Server

POST op/aaa/tacacsPlusServer

Add new TACACS+ server
PUT Update Server

PUT op/aaa/tacacsPlusServer

Update an existing TACACS+ server. The serverIp attribute must match the existing server to be modified, and cannot be changed.

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 Folder

DELETE op/cliTemplateConfiguration/folder

Delete folder
GET List Configuration Template Folders

GET op/cliTemplateConfiguration/folder

Get folders
POST Create Configuration Template Folder

POST op/cliTemplateConfiguration/folder

Create new folder
PUT Modify Configuration Template Content

PUT op/cliTemplateConfiguration/template

Update template. Does not support Converged Access Templates (IOS-XE templates and templates created from them).

Configuration Archive Service

Provides services for configuration file, diff and versions operations.

Resource Description API Version
GET Configuration archive list

GET data/ConfigArchives

Configuration archive for device
Represents information about the version of the configuration files
GET Download the sanitized configuration file

GET op/configArchiveService/extractSanitizedFile

Extract a sanitized configuration file (not applicable for config files with type VLAN and DATABASE)
GET Download the unsanitized configuration file

GET op/configArchiveService/extractUnsanitizedFile

Extract an unsanitized configuration file (not applicable for config files with type VLAN and DATABASE)

Group Management Service

The Group Management Service provides operations for getting group rules summary, deleting and updating groups, managing devices and rules assigned to groups.

Resource Description API Version
DELETE Delete device or port group

DELETE op/groups/group

Delete a device or port group by it's ID or full path and name. Only Location and 'User Defined' Device groups and 'User Defined' port groups are supported.
GET Device Group Rules

GET op/groups/groupRules

Get list of group rules. Only Location and Network Device groups are supported.
PUT Assign devices to a group

PUT op/groups/groupDevices

Statically assign list of devices to a group (devices are listed by device IDs or IP addresses). Only Location and User Defined device groups are supported.
Create or update a device or port group. Only 'Location' and 'User Defined' Device groups and 'User Defined' port groups are supported. You cannot modify the system defined groups except 'Location/All Locations/System Campus' for which you can change only description and geographical location.
PUT Remove devices from a group

PUT op/groups/removeDevices

Remove list of devices from a group (devices are listed by device IDs or IPs). Only Location and 'User Defined' Device groups are supported.
PUT Replace set of group rules

PUT op/groups/groupRules

Replace set of group rules with a new one. Only Location and Network Device groups are supported.

Plug and Play

Provides operations related to Plug And Play

Resource Description API Version
POST Create Update PnP Status

POST op/pnp/status/{serialNumber}

Trap Receivers

Provides for operations to retrieve, create, modify, and delete Trap Receivers.

Resource Description API Version
DELETE Delete Trap Receiver

DELETE op/trapReceiverService/receiver

Deprecated

Notification Receivers API is deprecated because Notification Receivers were replaced by Notification Policies. This resource will not delete receivers which (1) are used by more than one policy or (2) have other receivers associated with the same policy. This resource may be removed in a future release.

Deletes an existing northbound trap receiver destination and the associated notification policy.

The API supports only those trap receivers associated with one notification policy. If there is more than one policy mapped to the receiver, or the the policy is associated with any other receiver, then an explicit error will be thrown, and neither the receiver nor the policy will be deleted.

GET List Trap Receivers

GET op/trapReceiverService/list

Deprecated

Notification Receivers API is deprecated because Notification Receivers were replaced by Notification Policies. This resource will not list receivers which (1) are used by more than one policy or (2) have other receivers associated with the same policy. This resource may be removed in a future release.

Retrieves certain existing northbound trap receiver destinations with the associated notification policy.

Notification Policies underwent significant changes in Prime Infrastructure 3.2, therefore the API works with the following restrictions:

  • The API will return only those trap receivers associated with one notification policy. If there is more than one policy mapped to the receiver, or the policy is associated with any other receiver, then the API won't return it. Trap receivers that do not meet these restrictions won't be included to the response.

  • Notification Policies provide a more flexible way to configure category, device group, and severity filters.

    When any event type is selected in an alarm category, then the API will include this event category in the list of category filters.

    When any device type is selected under a device product family group, then the API will include this product family in the list of category filters.

    The API returns severity filters as a superset of all of the event type and alarm category severities selected in the notification policy.

  • The "Clear" severity was removed and will no longer be returned by the API.

POST Create Trap Receiver

POST op/trapReceiverService/receiver

Deprecated

Notification Receivers API is deprecated because Notification Receivers were replaced by Notification Policies. This resource may be removed in a future release.

Create a new northbound trap receiver destination with an associated notification policy.

Notification Policies underwent significant changes in Prime Infrastructure 3.2, therefore the API works with the following restrictions:

  • The API creates one or two notification policies depending on the provided alarm category filters:

    The first policy is created if default or "System" alarm categories are specified. The notification policy will contain a filter on event types which are in the selected alarm categories and have a severity matching the severities filter. The name of the policy is the same as the notification receiver name.

    If the alarm categories contain product families, then another notification policy will be created for the notification receiver. This notification policy will contain a filter on the selected product families and alarm severities. The name of the policy is the notification receiver name plus the "_PF" suffix.

    Note that the notification receiver won't be supported by the other Trap Receiver APIs if it is associated with two notification policies.
  • The notification receiver name and the policies names must be unique.
  • The "Clear" severity was deprecated. It will be silently ignored if passed in.

PUT Update Trap Receiver

PUT op/trapReceiverService/receiver

Deprecated

Notification Receivers API is deprecated because Notification Receivers were replaced by Notification Policies. This resource will not update receivers which (1) are used by more than one policy or (2) have other receivers associated with the same policy. This resource may be removed in a future release.

Updates an existing northbound trap receiver destination and the associated notification policy.

Notification Policies underwent significant changes in Prime Infrastructure 3.2, therefore the API works with the following restrictions:

  • The API supports only those trap receivers associated with one notification policy. If there is more than one policy mapped to the receiver, or the policy is associated with any other receiver, then an explicit error will be thrown, and the receiver will not be updated.

  • When the notification receiver is updated, then one additional policy may be created, depending on the provided alarm category filters:

    If the policy does not currently have default or "System" alarm categories, and they are added, an additional policy will be created. The notification policy will contain a filter on the event types which are in the selected alarm categories and have a severity matching the severities filter. The name of the policy is the same as the notification receiver name.

    If the policy does not currently have product family categories, and they are added, an additional policy will be created for notification receiver. This notification policy will contain filters on the selected product families and alarm severities. The name of the policy is the notification receiver name plus the "_PF" suffix.

    Note that after the update, the notification receiver won't be supported by the other Trap Receiver APIs if it is associated with two notification policies.
  • The notification receiver name must be unique. Created notification policy has the same name as notification receiver's therefore there should not be existing notification policy with this name.

  • The "Clear" severity was deprecated. It will be silently ignored if passed in.