Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

REST API Resources

Resource Aggregation Sorting Filtering Product Version Was updated

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. Either serverIp or serverHostName must match the existing server to be modified, and cannot be changed.

AP Onboarding Profile Management Service

Provides services to create, retrieve, update and delete AP Onboarding Profiles.

Resource Description API Version
GET Get AP onboarding profiles

GET data/ApOnboardingProfile

Returns a list of AP onboarding profiles
  • v1
  • v2
  • v3
  • v4
DELETE Delete AP onboarding profiles

DELETE op/apOnboarding/profile

Deletes AP Onboarding Profiles
  • v1
  • v2
  • v3
  • v4
POST Create AP onboarding profiles

POST op/apOnboarding/profile

Adds AP Onboarding Profiles
  • v1
  • v2
  • v3
  • v4
PUT Modify AP onboarding profile

PUT op/apOnboarding/profile

Updates AP Onboarding Profile
  • v1
  • v2
  • v3
  • v4

API Health Service

Provides services to monitor and diagnose API performance and usage.

Resource Description API Version
GET API Health Record

GET data/ApiHealthRecords

Represents API performance and diagnostic information.
GET API Response Time Summary

GET data/ApiResponseTimeSummary

Represents summarized information about response times for each service.
GET API Calls Per Client

GET op/apiHealth/callsPerClient

Returns the IP addresses of all clients using either all services or the specified service, over the last 24 hours.
GET API Request Count Trend

GET op/apiHealth/requestCountTrend

Reports the number of requests, grouped by day and HTTP status, for all services or a given service if specified, over the last seven days.
GET API Response Time Trend

GET op/apiHealth/responseTimeTrend

For each request over the last 24 hours, shows the response time and the time the request was received, either for all services or for the specified service.
GET API Service Name List

GET op/apiHealth/serviceNameList

Returns the list of services for which there are ApiHealthRecords.

Access Point Operations

Operations to delete and modify access points.

Resource Description API Version
GET Get Rx Neighbors

GET op/apService/rxNeighbors

Return Rx Neighbors of an access point. Only Unified access points are supported. Note that the Prime Infrastructure does not cache/persist Rx neighbors due to volatility of this data. Thus the API resource queries the network to obtain Rx neighbors. API response time may depend on a network condition and is limited to 30 seconds. If it can not get response from a network device within this interval an error will be returned.
  • v1
  • v2
  • v3
  • v4
PUT Delete Access Points By IDs

PUT op/apService/deleteById

An operation to delete unified AP and third party AP by IDs.
PUT Delete Access Points By Names

PUT op/apService/deleteAp

An operation to delete unified AP and third party AP by names.
PUT Modify Unified Access Point

PUT op/apService/accessPoint

Modifies an Unified Access Point. For API versions 1 and 2, all parameters should be specified. For API version 3, only the parameters desired to be changed and the ID need to be specified.
PUT Set Classification Type And Rogue State

PUT op/rogueAp/classification

Configures a classification type and state for rogue access points. The classification change can be performed only for non-cleared rogue AP alarms. To get the current classification type and rogue state, see the "rogueApAlarmDetails.classificationType" and "rogueApAlarmDetails.state" response parameters from the "GET data/RogueApAlarms" resource.
  • v1
  • v2
  • v3
  • v4

Alarms Management Service

The Alarms Management Service provides operations for marking alarms as acknowledged/unacknowledged, annotating, clearing alarms and clearing all alarms with provided event type.

Resource Description API Version
PUT Acknowledges Alarms

PUT op/alarms/acknowledge

Acknowledges one or more alarms by provided identificators
PUT Annotates Alarms

PUT op/alarms/annotate

Annotates one or more alarms
PUT Clears Alarms

PUT op/alarms/clear

Clears one or more alarms
PUT Clears Alarms with provided event type

PUT op/alarms/clearByEventType

Clears all alarms with provided event type
PUT Unacknowledges Alarms

PUT op/alarms/unacknowledge

Unacknowledges one or more alarms

Application Visibility and Control Service

Provides resources for discovering and controlling applications within the network.

Resource Description API Version
Returns the list of predefined and user-defined applications.
  • v1
  • v2
  • v3
  • v4

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
GET CLI Configuration Templates

GET data/CliTemplate

CLI configuration templates.
DELETE Delete Configuration Template

DELETE op/cliTemplateConfiguration/deleteTemplate

Deletes a template from the system.
DELETE Delete Configuration Template Folder

DELETE op/cliTemplateConfiguration/folder

Delete folder
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 Template Folders

GET op/cliTemplateConfiguration/folder

Get folders
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 Create Configuration Template Folder

POST op/cliTemplateConfiguration/folder

Create new folder
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.
PUT Deploy Configuration Template Through Job

PUT op/cliTemplateConfiguration/deployTemplateThroughJob

Deploy a template to a list of devices through Job. A job name will be returned.
  • Use the parameter startTime to define when the CLI template will be deployed. If the start time is not defined the deployment will start immediately. The start time should be provided in the ISO 8601 format. For example: v1/op/cliTemplateConfiguration/deployTemplateThroughJob?startTime="2016-11-9T07:00Z"
  • Use the job name to query the job result using Job Operations services. To query job status, use the query api/v1/data/JobSummary?jobName=CliTemplateDeploy123. To query the full run result if the deployment fails, use the query api/v1/op/jobService/runhistory?jobName=CliTemplateDeploy123
  • Does not support ports selection for the 'Ports' type templates.
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).

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.

Compliance Service

Provides service to compliance operations.

Compliance Services are disabled by default. In order to use them, the system administrator must enable the feature. Compliance Services are available only on the following Prime Infrastructure server options:
  • The Professional virtual appliance.
  • The Cisco Unified Computing System (UCS) Gen 2 physical appliance.
  • Standard Prime Infrastructure virtual appliance.
Resource Description API Version
GET Checks status of Check Job

GET op/compliance/check

Checks status of Compliance Check Job
POST Add policy

POST op/compliance/policy

Creates custom policy
POST Add profile

POST op/compliance/profile

Creates profile and associates policy
POST Import policy

POST op/compliance/policy/import

Creates custom policy from XML
POST Schedule a Check Job

POST op/compliance/run

Schedules a Compliance Check Job

Configuration Archive Service

Provides services for configuration file, diff and versions operations.

Resource Description API Version
GET Bulk export sanitized configuration archives

GET data/BulkSanitizedConfigArchives

Intended to bulk export of sanitized configuration files from archive. This API resource does not support filtering and sorting on configuration files content.
GET Bulk export unsanitized configuration archives

GET data/BulkUnsanitizedConfigArchives

Intended to bulk export of unsanitized configuration files from archive. This API resource does not support filtering and sorting on configuration files content.
GET Configuration archive list

GET data/ConfigArchives

Configuration archive for device
Represents information about the version of the configuration files
GET Configuration Diff

GET op/configArchiveService/configDiff/{device}

Compute Running Configuration Diff. Currently supported only for router devices.
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)

Credential Profile Management Service

Provides services to create, retrieve, update and delete credential profiles

Resource Description API Version
DELETE Delete credential profile

DELETE op/credentialProfilesManagement/credentialProfiles

Deletes a credential profile.
GET Get credential profiles

GET op/credentialProfilesManagement/credentialProfiles

Returns list of credential profiles.
GET Get list of configured devices

GET op/credentialProfilesManagement/deviceList

Returns list of devices configured with the credential profile.
POST Create credential profile

POST op/credentialProfilesManagement/credentialProfiles

Creates a new credential profile.
PUT Update credential profile

PUT op/credentialProfilesManagement/credentialProfiles

Updates an existing credential profile. Profile name is used to identify the credential profile to be edited. After updating the profile, you can synchronize devices using the POST op/devices/syncDevices resource.

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

Deprecated

Do not use this resource. Credentials can be retrieved through API "GET-devices/exportDevices".

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 Meraki Access Points

GET data/MerakiAccessPoints

Represents basic information about Meraki access points.
  • v1
  • v2
  • v3
  • v4
GET Meraki Devices

GET data/MerakiDevices

Represents basic information about Meraki devices. The API resource does not include Meraki access points or Meraki dashboard devices.
  • v1
  • v2
  • v3
  • v4
GET RogueApAlarms

GET data/RogueApAlarms

Represents Rogue Access Point Alarms. It includes basic alarm attributes and additional details for Rogue AP 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 RogueApDetectionHistory

GET data/RogueApDetectionHistory

Represents Rogue AP detection history data. Use alarmId or rogueMacAddress attribute to filter detection history for a certain Rogue AP.
  • v1
  • v2
  • v3
  • v4
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)

Device Operations

Operations to create, update, and delete devices.

Resource Description API Version
GET Export Devices

GET op/devices/exportDevices

An operation to export a list of devices. It accepts three parameters: ipAddress, groupId or groupPath. If no parameters are specified, no devices will be exported.

Filtering operators can be applied to the parameters. Use the GET data/GroupSpecification resource to obtain groupId or groupPath information.

Examples

  • ipAddress=192.168.1.1 — export one device by IP
  • ipAddress=in("192.168.1.1","192.168.1.2") — export multiple devices by IPs
  • ipAddress=startsWith("192.168.1") — export devices by ip range. Other filtering could be endsWith, contains
  • groupPath=startsWith("Device Type/Wireless Controller") — export devices by the group Device Type/Wireless Controller and its child groups
  • groupPath="Device Type/Wireless Controller/Cisco 5500 Series Wireless LAN Controllers"&ipAddress=startsWith("171")— export devices by a group and IP range in that group
  • groupId=in(81160,81161) — export devices by groupIds
POST Delete devices through job

POST op/devices/removalJob

Delete one or more devices through a batch job.
POST Synchronize devices

POST op/devices/syncDevices

Synchronize devices. Forces an inventory collection of the specified devices. The API accepts the hostname, the IP address, or the management address of the device.
PUT Bulk Import

PUT op/devices/bulkImport

An operation to add or update multiple devices using a batch job.

Credential Profiles Support

  • There are limitations on importing devices with a credential profile. If credentialProfileName parameter is specified and is not empty, this device should not contain any other credential parameters. Parameters allowed to be used with credentialProfileName are: ipAddress, networkMask, and udfs. If other credential parameters are set along with credentialProfileName they will be ignored.

User Defined Field Support

  • This service supports importing and exporting devices with User Defined Fields (UDF).
  • The maximum length of a UDF value is 255 characters; devices which have UDF values greater than 255 characters will be ignored.
  • Each bulk Import service request overwrites existing UDF records. To update the UDF of a device, follow the steps:
    • Retrieve the full list UDFs of the device using the GET op/devices/exportDevices resource.
    • Find the UDF entry to be updated in the list.
    • Assign the new value of the entry.
    • Use this resource to save the change.

TL1 Credentials Support

  • Transaction Language 1 (TL1) credentials are not currently supported for this operation.
PUT Delete Devices

PUT op/devices/deleteDevices

Deprecated

This operation deletes devices in a synchronized way which may take a long time to respond. Use the Delete devices through job resource (POST op/devices/removalJob) instead

An operation to delete devices by ip address. The response time of this service varies and depends on the status of the devices. The API accepts the hostname, the IP address, or the management address of the device to be deleted. Firstly, the API tries to find the device by its management address. Then, if it has not been found, the API tries to find it by IP address and hostname. If there are more than one device with the same IP address or hostname an error will be returned. In this case you should use management address to delete the device.
PUT Schedule AP Maintenance Mode

PUT op/configure/ap/scheduleMaintenanceMode

Creates a job to set maintenance mode for unified access points. For other device types should use "PUT op/configure/device/scheduleMaintenanceMode". Maintenance mode status for a unified AP can be retrieved with the response parameter "unifiedApInfo.maintenanceMode" from the "GET data/AccessPointDetails" resource.
  • v1
  • v2
  • v3
  • v4
PUT Schedule Maintenance Mode

PUT op/configure/device/scheduleMaintenanceMode

Creates a job to set maintenance mode. This resource is intended for use with routers, switches, wireless controllers, autonomous access points, and other types of devices except for unified access points. To get the current management status and the maintenance mode reason for a device, see the "managementStatus" and "collectionDetail" response parameters from the "GET data/Devices" resource.
  • v1
  • v2
  • v3
  • v4
PUT Set AP Maintenance Mode

PUT op/configure/ap/maintenanceMode

Sets the maintenance mode for unified access points. For other device types should use "PUT op/configure/device/maintenanceMode". Maintenance mode status for a unified AP can be retrieved with the response parameter "unifiedApInfo.maintenanceMode" from the "GET data/AccessPointDetails" resource.
  • v1
  • v2
  • v3
  • v4
PUT Set Device Maintenance Mode

PUT op/configure/device/maintenanceMode

Sets the device maintenance mode. This resource is intended for use with routers, switches, wireless controllers, autonomous access points, and other types of devices except for unified access points. For unified access points, please use "PUT op/configure/ap/maintenanceMode" To get the current management status and the maintenance mode reason for a device, see the "managementStatus" and "collectionDetail" response parameters from the "GET data/Devices" resource.
  • v1
  • v2
  • v3
  • v4

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.
PUT Assign interfaces to a group

PUT op/groups/groupInterfaces

Statically assign list of interfaces to given port group. Only 'User Defined' and 'WAN Interfaces' port 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 Remove interfaces from a group

PUT op/groups/removeInterfaces

Remove a list of interfaces from a given port group. Only 'User Defined' and 'WAN Interfaces' port 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.

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 Group Specification

GET data/GroupSpecification

Provides a view of group specific information of devices. Use this service to query or navigate groups
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".
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. Note that the API can be slow when you have large amount of groups, alarms, and devices. Use noAlarms and noMembersCount parameters to improve the performance of this API resource.
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.

Guest User Management Service

Provides services to create, retrieve, update and delete guest users. You can use GET data/WlanControllers resource for getting an information about controllers.

Resource Description API Version
GET Get guest users

GET data/GuestUsers

Returns a list of guest users.
GET Get guest users from controller

GET op/guestUser/guestUsersOnController

Lists guest user names currently associated with a particular controller.
GET Get logged in guest users from controller

GET op/guestUser/loggedInGuestUsersOnController

Lists guest user names currently logged in and associated to a particular controller.
POST Create guest user

POST op/guestUser

Creates a new guest user.
PUT Delete guest user

PUT op/guestUser/delete

Deletes a guest user.
PUT Update guest user

PUT op/guestUser

Updates an existing guest user. User name is used to identify the guest user to be edited.

Job Operations

To check job status, suspend, cancel and resume jobs.

Resource Description API Version
GET Job Summary

GET data/JobSummary

Provides a consolidated view of the latest status of all scheduled jobs. Use this resource to get a quick job status check. To query system jobs , specify username=SYSTEM
GET Query Job Run History

GET op/jobService/runhistory

Query the past run instances of a job. All request parameters are optional.

If no parameters are specified, If no parameters are specified, no run instances will be returned.. NBI filtering can be applied to the parameters to customize the query. Please refer the filtering page for the details of how to use filtering

Examples :

  • get the run history of the job 123 --/jobService/runhistory?jobId=123
  • get the run history of job 123 and job 456 between 2013-04-26T14:00:00 and 2013-04-26T16:00:00 -- /jobService/runhistory?jobId=in(123,456)&startTime=between("2013-04-26T14:00:00","2013-04-26T16:00:00")
  • get all run history of jobs with job name starting with "BulkImport" -- jobService/runhistory?jobName=startsWith("BulkImport")
PUT Cancel A Job

PUT op/jobService/cancel

Disable the trigger permanently. The canceled job cannnot be resumed using "Resume A Job" service
PUT Cancel A Job running instance

PUT op/jobService/cancelrunning

Stop a running instance of a job.
PUT Resume A Job

PUT op/jobService/resume

Re-enable the trigger of a suspended job.
PUT Suspend A Job

PUT op/jobService/suspend

Disable the trigger temporarily. The job will no longer run when suspended. To re-enable the job trigger, use 'Resume A Job' service. Suspending a job in running status dose not impact the running instance.

MAC Filters Management Service

Provides services to create, retrieve, update and delete mac filters.

Resource Description API Version
GET MAC Filter Templates

GET data/MacFilterTemplates

Returns a list of MAC filter templates.
DELETE Delete MAC Filter Template

DELETE op/macFilter/macFilterTemplate

Deletes an existing MAC filter template.
POST Create MAC Filter Template

POST op/macFilter/macFilterTemplate

Create new MAC filter template.
PUT Deploy MAC Filter Template

PUT op/macFilter/deploy

Deploy a MAC filter to WLAN controllers.
PUT Update MAC Filter Template

PUT op/macFilter/macFilterTemplate

Updates an existing MAC filter template. Template name is used to identify the template to be edited.

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.

Plug and Play

Provides operations related to Plug And Play

Resource Description API Version
DELETE Delete All Profile Instances of a PnP Profile

DELETE op/pnp/profile/{profileName}/instance/

Deletes all the profile instances of the given pnp profile that passed as path param.
DELETE Delete Pnp Profile

DELETE op/pnp/profile/{pnpProfileFolder}/{profileName}

Deletes the exisiting Pnp profiles.
DELETE Delete Profile Instance of a PnP Profile

DELETE op/pnp/profile/{profileName}/instance/{instanceName}

Deletes the profile instance of the given pnp profile that passed as path param.
GET Get All Profile Instances of a PnP Profile

GET op/pnp/profile/{profileName}/instance/

Takes PnP Profile Name as rest parameter. It returns the set of all Profile Instances of the passed PnP Profile.
GET Get Profile Instance of PnP Profile

GET op/pnp/profile/{profileName}/instance/{instanceName}

Takes PnP Profile Name and Instance Name as rest parameters. It returns the Profile Instance.
GET Read All Pnp Profiles

GET op/pnp/profile/{pnpProfileFolder}

Read all the pnp profiles inside a folder
GET Read Pnp Profile

GET op/pnp/profile/{pnpProfileFolder}/{profileName}

Get the attributes of the given pnp profile
POST Create Pnp Profile

POST op/pnp/profile/{pnpProfileFolder}

Creates Pnp profiles
POST Create Update PnP Status

POST op/pnp/status/{serialNumber}

POST Create or Update Profile Instances of a PnP Profile

POST op/pnp/profile/{profileName}/instance/

Takes Profile Name as rest parameter and List of Profile Instances as payload. If Profile Instance with same name and same profile exist, those get updated otherwise new Profile Instance will be created.
PUT Update Pnp Profile

PUT op/pnp/profile/{pnpProfileFolder}

Updates the existing pnp profiles

Rate Limits Management Service

Provides services to obtain and update rate limits

Resource Description API Version
GET Get Rate Limits

GET op/rateService/rateLimits

Return current rate limiter settings.
  • v1
  • v2
  • v3
  • v4
PUT Update Rate Limits

PUT op/rateService/rateLimits

Update rate limiter settings. The updated settings take effect immediately.
  • v1
  • v2
  • v3
  • v4

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.

GET Run a ZIP Report

GET op/reportService/zipReport

This API operation is used to generate reports from a specific saved report template and return the report output as ZIP of one or more CSV files. It takes one argument, a String reportTitle, which is the name of the saved report template. This API features similarly to the export functionality available in the Report Launch Pad.

Software Updates

Provides information about Software Updates.

Resource Description API Version
GET Information about current platform

GET op/update/platformInfo

Retrieves the information about current platform
  • /op/update/platformInfo - return the MDF ID and the version of the underlying platform
GET Information about updates

GET op/update/retrieve

Retrieves the information about updates for a given UBF name or state. Here are the sample queries
  • /op/update/retrieve - return the information about all updates
  • /op/update/retrieve?ubfname=prime_insight_call_home_agent-1.0.0.ubf - return the information about update from UBF with specified name
  • /op/update/retrieve?state=INSTALLED - return the information about updates with state = "INSTALLED"
  • /op/update/retrieve?ubfname=prime_insight_call_home_agent-1.0.0.ubf&state=INSTALLED - return the information about update for a given UBF name and state = "INSTALLED"
Available states:
  • AVAILABLE
  • AVAILABLE_PENDING_RESTART
  • INSTALLED
  • INSTALLED_PENDING_RESTART
  • ERROR_ON_INSTALL
  • ERROR_ON_ROLLBACK

Statistics

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

Resource Description API Version
GET All Border Routers

GET op/pfrMonitoringExt/getAllBorderRouters/{startTime}/{endTime}/{siteName}

Fetches all Border Routers in a PfR controlled site that are actively exporting PfR NetFlow within a specified time range.The URL Format is: /op/pfrMonitoringExt/getAllBorderRouters/startTime/endTime/siteName?siteHierachyPath. Here are the sample queries:
  • /op/pfrMonitoringExt/getAllBorderRouters/1475824562/1476429362/BANGALORE -- Returns all Border Routers in a PfR controlled site that are actively exporting pfr Netflow within a specified time range for the give site.
  • /op/pfrMonitoringExt/getAllBorderRouters/1475824562/1476429362/BANGALORE? hierarchyPath=/Location/All Locations-- Returns all Border Routers in a PfR controlled site that are actively exporting pfr Netflow within a specified time range for the given site under the given hierarchyPath.
GET All IMEs

GET op/pfrMonitoringExt/getAllIMEs/{srcSite}/{dstSite}/{startTime}/{endTime}

Fetches all Immitigable events reported from the Master Controller of the source site for a Site-to-Site communication.Immitigable events typically indicate that for a particular class of traffic, PfR feature (running on Cisco devices) is unable to automatically circumvent Network issues by re-routing traffic .The URL format is:/op/pfrMonitoringExt/getAllIMEs/srcSite/dstSite/startTime/endTime?srcHierarchyPath&destHierarchyPath. Here are the sample queries:
  • /op/pfrMonitoringExt/getAllIMEs/BANGALORE/SAN JOSE/1475824562/1476429362-- Returns all Immitigable events reported from the Master Controller of the source site for a Site-to-Site communication within a specified time range.
  • /op/pfrMonitoringExt/getAllIMEs/BANGALORE/SAN JOSE/1475824562/1476429362?srcHierarchyPath=/Location/All locations-- Returns all Immitigable events reported from the Master Controller of the source site for a given Site-to-Site communication under srcHierarchyPath within a specified time range.
  • /op/pfrMonitoringExt/getAllIMEs/BANGALORE/SAN JOSE/1475824562/1476429362?srcHierarchyPath=/Location/All locations&destHierarchyPath=/Location/All locations/INDIA-- Returns all Immitigable events reported from the Master Controller of the source site for a given Site-to-Site communication under srcHierarchyPath and destHierarchyPath within a specified time range.
GET All RCs

GET op/pfrMonitoringExt/getAllRCs/{srcSite}/{dstSite}/{startTime}/{endTime}

Fetches all Route Change events reported from the Master Controller of the source site for a Site-to-Site communication. A Route Change event typically indicates that for a given class of traffic, PfR feature (running on Cisco devices) is able to automatically circumvent Network issues by re-routing traffic.The URL format is:/op/pfrMonitoringExt/getAllRCs/srcSite/dstSite/startTime/endTime?srcHierarchyPath&destHierarchyPath. Here are the sample queries:
  • /op/pfrMonitoringExt/getAllRCs/BANGALORE/SAN JOSE/1475824562/1476429362-- Returns Route Change events reported from the Master Controller of the source site for a given Site-to-Site communication within a specified time range.
  • /op/pfrMonitoringExt/getAllRCs/BANGALORE/SAN JOSE/1475824562/1476429362?srcHierarchyPath=/Location/All locations-- Returns Route Change events reported from the Master Controller of the source site for a given Site-to-Site communication under srcHierarchyPath within a specified time range.
  • /op/pfrMonitoringExt/getAllRCs/BANGALORE/SAN JOSE/1475824562/1476429362?srcHierarchyPath=/Location/All locations&destHierarchyPath=/Location/All locations/INDIA-- Returns Route Change events reported from the Master Controller of the source site for a given Site-to-Site communication under srcHierarchyPath and destHierarchyPath within a specified time range.
GET All TCAs

GET op/pfrMonitoringExt/getAllTCAs/{srcSite}/{dstSite}/{startTime}/{endTime}

Fetches all Threshold Crossing Alerts reported from the Master Controller of the source site for a Site-to-Site communication within a specified time range. A Threshold Crossing Alert typically indicates that for a given class of traffic, PfR feature (running on Cisco devices) has identified network issues that are imparing the traffic quality (measured in terms of Jitter, Delay, Packet Loss). The URL format is:/op/pfrMonitoringExt/getAllRCs/srcSite/dstSite/startTime/endTimes?rcHierarchyPath&destHierarchyPath. Here are the sample queries:
  • /op/pfrMonitoringExt/getAllTCAs/BANGALORE/SAN JOSE/1475824562/1476429362-- Returns all Threshold Crossing Alerts reported from the Master Controller of the source site for a given Site-to-Site communication within a specified time range.
  • /op/pfrMonitoringExt/getAllTCAs/BANGALORE/SAN JOSE/1475824562/1476429362?srcHierarchyPath=/Location/All locations-- Returns all Threshold Crossing Alerts reported from the Master Controller of the source site for a given Site-to-Site communication under srcHierarchyPath within a specified time range.
  • /op/pfrMonitoringExt/getAllTCAs/BANGALORE/SAN JOSE/1475824562/1476429362?srcHierarchyPath=/Location/All locations&destHierarchyPath=/Location/All locations/INDIA-- Returns all Threshold Crossing Alerts reported from the Master Controller of the source site for a given Site-to-Site communication under srcHierarchyPath and destHierarchyPath within a specified time range.
GET All WANInterfaces

GET op/pfrMonitoringExt/getAllWANInterfaces/{startTime}/{endTime}/{siteName}/{brIp}

Fetches all the WAN Interface details active within a specific time range for a given site and its Border Router.The URL format is:/op/pfrMonitoringExt/getAllWANInterfaces/startTime/endTime/siteName/brIp?srcHierarchyPath. Here are the sample queries:
  • /op/pfrMonitoringExt/getAllWANInterfaces/1475824562/1476429362/BANGALORE/150.150.0.35 -- Returns the WAN interface active details for the given site and device ip within startTime and endTime.
  • /op/pfrMonitoringExt/getAllWANInterfaces/1475824562/1476429362/BANGALORE/150.150.0.35?srcHierarchyPath=/Location/All locations -- Returns the WAN interface active details for the given site and device ip under srcHierarchyPath within StartTime and endTime.
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 Top N Volumes With Sites Statistics

GET op/statisticsService/application/topNApplicationsWithSites

Retrieves the top N applications by volume with detailed statistics by sites.
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 Client Distribution Data

GET op/statisticsService/clients/distributions/{distribution}

Fetches the distribution data for Clients
GET Client Distribution Supported

GET op/statisticsService/clients/distributions

Fetches the URLs for various distributions of Clients
GET Cluster Details

GET op/statisticsService/clusters

Deprecated

Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices.

Fetches the details of Clusters
GET Cluster Metric Data

GET op/statisticsService/clusters/metrics/{metric}

Deprecated

Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices.

Fetches the metric data for a Cluster
GET Cluster Metrics Supported

GET op/statisticsService/clusters/metrics

Deprecated

Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices.

Fetches the URLs for various metrics of a Cluster
GET DSCP App Usage

GET op/pfrMonitoringExt/getDscpAppUsage/{startTime}/{endTime}

Fetches WAN Link bandwidth usage in terms of data volume w.r.t DSCP and applications classified for that DSCP, withinin a specified time range for a site pair. This API accepts the Site names and Site hierarchies.The URL format is:/op/pfrMonitoringExt/getDscpAppUsage/startTime/endTime?srcSiteName&dstSiteName&managedIpBR&tunnelName&srcHierarchyPath&destHierarchyPath. Here are the sample queries:
  • /op/pfrMonitoringExt/getDscpAppUsage/1475824562/1476429362 --Returns WAN Link bandwidth usage in terms of data volume within the given startTime and endTime
  • /op/pfrMonitoringExt/getDscpAppUsage/1475824562/1476429362?srcSiteName=BANGALORE&dstSiteName=SAN JOSE&managedIpBR=10.1.1.1&tunnelName=tunnel1&srcHierarchyPath=Location/All Locations&destHierarchyPath=Location/All Locations/INDIA --Returns WAN Link bandwidth usage in terms of data volume for the given site pair under srcHierarchyPath and destHierarchyPath within StartTime and endTime.
GET DSCP App Usage For Live Topo

GET op/pfrMonitoringExt/getDscpAppUsageForLiveTopo/{startTime}/{endTime}/{srcSiteId}/{dstSiteId}

Fetches WAN Link bandwidth usage in terms of data volume w.r.t DSCP and applications classified for that DSCP, within a specified time range for a site pair and a VRF. This API accepts Site Ids in Prime and VRF Ids assigned by Prime PfR NetFlow processing. The pre-requisite of using this API is to fetch the Site Ids and VRF Ids stored in Prime and then use those Ids in this API. The URL format is:/op/pfrMonitoringExt/getDscpAppUsageForLiveTopo/startTime/endTime/srcSiteId/dstSiteId?vrfIdList. Here are the sample queries:
  • /op/pfrMonitoringExt/getDscpAppUsageForLiveTopo/1475824562/1476429362/84116/6439435 -- Returns the WAN Link bandwidth usage for the given source site id, destination site id and within the startTime and endTime
  • /op/pfrMonitoringExt/getDscpAppUsageForLiveTopo/1475824562/1476429362/84116/6439435?vrfIdList=vrfidlist -- Returns the WAN Link bandwidth usage for the given source site id, destination site id, vrf id and within the startTime and endTime
GET DSCP Time Vs Usage Chart

GET op/pfrMonitoringExt/getDSCPTimeVsUsageChart/{startTime}/{endTime}/{siteName}/{brIp}/{dscp}/{noOfPoints}

Provides a trending report of DSCP and its associated application usage for a given time frame, a source site, its Border Router and the WAN link. The URL format is:/op/pfrMonitoringExt/getDSCPTimeVsUsageChart/startTime/endTime/siteName/brIp/dscp/noOfPoints?interfaceName. Here are the sample queries:
  • op/pfrMonitoringExt/getDSCPTimeVsUsageChart/1475824562/1476429362/BANGALORE/150.150.0.35/456/5--Returns 5 trending reports of DSCP and its associated application usage for the given site,device ip within startTime and endTime
  • op/pfrMonitoringExt/getDSCPTimeVsUsageChart/1475824562/1476429362/BANGALORE/150.150.0.35/456/5?interfaceName=GigabitEthernet0 -- Returns 5 trending report of DSCP and its associated application usage for the given site,device ip,interface within the given startTime and endTime
GET Datacenter Details

GET op/statisticsService/datacenters

Deprecated

Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices.

Fetches the details of Datacenters
GET Datacenter Metric Data

GET op/statisticsService/datacenters/metrics/{metric}

Deprecated

Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices.

No metrics are available for Datacenters
GET Datacenter Metrics Supported

GET op/statisticsService/datacenters/metrics

Deprecated

Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices.

No metrics are available for Datacenters
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 Metric Data

GET op/statisticsService/devices/metrics/{metric}

Fetches the metric data for the device. Data are represented by a list of pairs. Each pair contains metric value and timestamp when this value was collected.
GET Device Metrics Supported

GET op/statisticsService/devices/metrics

Fetches the URLs for various metrics of the device.
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 Device Resource

GET op/statisticsService/devices

Fetches the basic details of devices and REST URL links to their children and metrics.
GET Host Details

GET op/statisticsService/hosts

Deprecated

Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices.

Fetches the details of Hosts
GET Host Metric Data

GET op/statisticsService/hosts/metrics/{metric}

Deprecated

Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices.

Fetches the metric data for a Host
GET Host Metrics Supported

GET op/statisticsService/hosts/metrics

Deprecated

Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices.

Fetches the URLs for various metrics of a Host
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 Metric Data

GET op/statisticsService/interfaces/metrics/{metric}

Fetches the metric data for an Interface

Additional metric request parameters:
  • isFullHierarchy — Specifies full or short class hierarchy. Default is false.
    qosclassmap
  • direction — 1 - input, 2 - output (default).
    qosclassmap, qosclassmaptoptrend
  • qosRateField — One of dropPolicyToggle (default), prePolicyToggle, postPolicyToggle.
    qosclassmaptoptrend
  • trafficDirection — One of ALL (default), IN, OUT.
    topnapplication, topapplicationtrafficovertime
  • sortOrder — One of DESC (default), ASC.
    topnapplication, topapplicationtrafficovertime
  • networkAwareType — Network aware. Wireless: 1, Wired: 2, All: -1 (default).
    topnapplication, topapplicationtrafficovertime
  • appId — Comma separated application IDs. Default is 0 (all applications).
    topnapplication, topapplicationtrafficovertime
  • siteId — Site ID. Default is 0 (all sites).
    topnapplication, topapplicationtrafficovertime
  • dataType — One of rate (default), volume.
    topnapplication, topapplicationtrafficovertime
  • dscp — DSCP.
    topnapplication
  • metricDataType — One of TOP_N, TIME_SERIES. Current metric's default data type is used if this parameter is not set.
GET Interface Metrics Supported

GET op/statisticsService/interfaces/metrics

Fetches the URLs for various metrics of an Interface
GET Interface Resource

GET op/statisticsService/interfaces

Fetches the basic details of interfaces and REST URL links to their children and metrics
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 Lisp Map Summary Trend

GET op/device-rest/DeviceLispMapSummary/{deviceIp}/{startTime}/{endTime}

Retrieves the lisp map-cache size over time trend for a given device in the selected time interval
GET Memory Utilization Trend

GET op/statisticsService/device/memoryUtilTrend

Retrieves the device memory utilization trend.
GET OutStanding IMEs For Site

GET op/pfrMonitoringExt/getOutStandingIMEsForSite/{startTime}/{endTime}/{srcSite}

Fetches immitigable events for out going traffic for a given site within a time range. The URL format is:/op/pfrMonitoringExt/getOutStandingIMEsForSite/startTime/endTime/siteName?siteHierarchyPath. Here are the sample queries:
  • /op/pfrMonitoringExt/getOutStandingIMEsForSite/1475824562/1476429362/BANGALORE-- Returns immitigable events for the given site within startTime and endTime
  • /op/pfrMonitoringExt/getOutStandingIMEsForSite/1475824562/1476429362/BANGALORE?siteHierarchyPath=Location/All Locations/INDIA -- Returns immitigable events for the given site under siteHierarchyPath within startTime and endTime
GET Reachable UCI Devcies

GET op/device-rest/UciDeviceReachability/{groupId}/{startTime}/{endTime}/{maxrecords}

Fetches UCI Reachable Devices
GET Refresh App Cache

GET op/pfrMonitoringExt/refreshAppCache

Refresh App Cache
  • /op/pfrMonitoringExt/pfrMonitoringExt/refreshAppCache
GET Resource Types Supported

GET op/statisticsService/resourceTypes

Fetches the various resources that support statistics service APIs
GET Site App Health

GET op/pfrMonitoringExt/getSiteAppHealth/{startTime}/{endTime}

Provides overall application health status of a site in terms of RED and GREEN based on resolved / un-resolved traffic issues. The URL format is:/op/pfrMonitoringExt/getSiteAppHealth/startTime/endTime. Here are the sample queries:
  • /op/pfrMonitoringExt/getSiteAppHealth/startTime/endTime-- Returns the overall application health status of a site within the given start time and end time
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 Threshold Violated Applications

GET op/statisticsService/applications/appHealthCrossing

Retrieves the list of applications which have values that have crossed the historical baselines or the defined health rule for the given group, For getting Fabric based data, pass the fabric id in siteId parameter. Here are the sample queries
  • /op/statisticsService/applications/appHealthCrossing?siteId=12121&startTime=4321&endTime=54321 -- Returns the list of applications which have values that have crossed the historical baselines or the defined health rule for a given site id with start time and end time
  • /op/statisticsService/applications/appHealthCrossing?siteId=12121&range=54321 -- Returns list of applications which have values that have crossed the historical baselines or the defined health rule for a given site id with range
GET Top N Application Hosts

GET op/statisticsService/application/topNHosts

Retrieves the top N application hosts.
GET Top N Applications

GET op/statisticsService/applications/performance

Retrieves the top N applications for a given group/site with given time period. If the group is Fabric, please mark isFabric=true else the parameter can be set to false or can be omitted in the URL. Here are the sample queries
  • /op/statisticsService/applications/performance?siteId=12121&startTime=4321&endTime=54321&isFabric=true -- Returns the Top 15 Applications for a given site id with start time and end time
  • /op/statisticsService/applications/performance?siteId=12121&range=54321&isFabric=true -- Returns the Top 15 Applications for a given site id with range
GET Top N Applications Over Time

GET op/statisticsService/applications/overtime

Retrieves the top N applications over time for a given group/site with given time period. If the group is Fabric, please mark isFabric=true else the parameter can be set to false or can be omitted in the URL. Here are the sample queries
  • /op/statisticsService/applications/overtime?siteId=12121&startTime=4321&endTime=54321&isFabric=true -- Returns the top 15 Applications overtime for a given site id with start time and end time
  • /op/statisticsService/applications/overtime?siteId=12121&range=54321&isFabric=true -- Returns the top 15 Applications overtime for a given site id with range
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 Cache

GET op/device-rest/TopNDeviceCache/ALL/{groupId}/{startTime}/{endTime}/{topn}

Retrieves the top N devices by LISP map-cache usage
  • /op/device_rest/TopNDeviceCache/ALL/Location_All Locations_Fabric_overlay group/1475824562/1476429362/5-- Return 5 lisp devices under overlay group within a specified time range.
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 TopNApplication Usage Over Time

GET op/pfrMonitoringExt/getTopNApplicationUsageOverTimeOld/{startTime}/{endTime}/{deviceIp}/{rownum}

Fetches application usage trend over time from AVC NetFlow from a Border / Core Router The URL format is:/op/pfrMonitoringExt/getTopNApplicationUsageOverTimeOld/startTime/endTime/deviceIp/rownum?interfaceName Here are the sample queries:
  • /op/pfrMonitoringExt/getTopNApplicationUsageOverTimeOld/1475824562/1476429362/10.1.1.1/5-- Returns the application usage trend overtime from AVC NetFlow from a Border / Core Router for the given device ip address and within startTime and endTime
  • /op/pfrMonitoringExt/getTopNApplicationUsageOverTimeOld/1475824562/1476429362/10.1.1.1/5?interfaceName=GigabitEthernet0 --Returns the application usage trend overtime from NetFlow from a Border / Core Router for the given ip address, interface and within startTime and endTime
GET TopNApplication Usage Over Time PfR

GET op/pfrMonitoringExt/getTopNApplicationUsageOverTime/{startTime}/{endTime}/{deviceIp}/{rownum}

Fetches application usage trend over time from PfR NetFlow from a Border Router. This API provides only the Egress Application usage information. The URL format is:/op/pfrMonitoringExt/getTopNApplicationUsageOverTime/startTime/endTime/deviceIp/rownum?interfaceName. Here are the sample queries:
  • /op/pfrMonitoringExt/getTopNApplicationUsageOverTime/1475824562/1476429362/10.1.1.1/5 -- Returns the application usage trend over time from PfR NetFlow from a Border Router for the given device ip and within startTime and endTime
  • op/pfrMonitoringExt/getTopNApplicationUsageOverTime/1475824562/1476429362/10.1.1.1/5?interfaceName=GigabitEthernet0 --Returns the application usage trend over time from PfR NetFlow from a Border Router for the given device ip, intreface and within startTime and endTime
GET Total Application Count

GET op/statisticsService/applications/appCount

Retrieves the total count of all the applications in a given UCI fabric. The fabric id needs to be set in the siteid parameter of the URL. Here are the sample queries
  • /op/statisticsService/applications/appCount?siteId=12121&startTime=4321&endTime=54321 -- Returns the total count of all the applications for a given site id with start time and end time
  • /op/statisticsService/applications/appCount?siteId=12121&range=54321 -- Returns the total count of all the applications for a given site id with range
GET Unreachable UCI Devcies

GET op/device-rest/UnReachableUciDevice/{groupId}/{startTime}/{endTime}/{maxrecords}

Fetches UCI Unreachable Devices
GET VM Details

GET op/statisticsService/vms

Deprecated

Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices.

Fetches the details of VMs
GET VM Metric Data

GET op/statisticsService/vms/metrics/{metric}

Deprecated

Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices.

Fetches the metric data for a VM
GET VM Metrics Supported

GET op/statisticsService/vms/metrics

Deprecated

Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices.

Fetches the URLs for various metrics of a VM
GET WAN Utilization Over TimeRate For Link

GET op/pfrMonitoringExt/getWanUtilizationOverTimeRateForLink/{startTime}/{endTime}/{brIpAddr}/{direction}

Fetches WAN Utilization Over Time Rate For Link
GET WanUtilization Over Time For Link

GET op/pfrMonitoringExt/getWanUtilizationOverTimeForLink/{startTime}/{endTime}/{brIpAddr}/{direction}

Fetches WAN Link utilization trend over time from PfR Bandwidth NetFlow from a Border Router for either IN or OUT direction. The URL format is:/op/pfrMonitoringExt/getWanUtilizationOverTimeForLink/startTime/endTime/deviceIp/rownum?interfaceName. Here are the sample queries:
  • /op/pfrMonitoringExt/getWanUtilizationOverTimeForLink/1475824562/1476429362/10.1.1.1/5?interfaceName=GigabitEthernet0 -- Returns the WAN Link utilization trend over time from PfR Bandwidth NetFlow from a given Border Router,inerface within the startTime and endTime
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.
POST DSCP vs All TCA

POST op/pfrMonitoringExt/getDSCPvsAllTCAViaPost/{startTime}/{endTime}

Fetches TCA events experienced by various DSCPs in a PfR controlled network. This call is over HTTP(s) POST where a filter object having one or more or none of the below filters can be applied 1) Source Site 2) Destination Site 3) DSCP 4) Service Provider 5) TCA Metrics The URL format is:/op/pfrMonitoringExt/getDSCPvsAllTCAViaPost/startTime/endTime. Here are the sample queries:
  • /op/pfrMonitoringExt/getDSCPvsAllTCAViaPost/1475824562/1476429362 + PostBody -- Returns TCA events experienced by various DSCPs in a PfR controlled network

Sample PostBody:

{ "pfRLandingPageFilterDTO" : { "dSCPs" : { "dSCPs" :"5" } } }

POST DSCP vs UrTCA

POST op/pfrMonitoringExt/getDSCPvsUrTCAViaPost/{startTime}/{endTime}

Fetches UnReachable events experienced by various DSCPs in a PfR controlled network. This call is over HTTP(s)POST where a filter object having one or more or none of the below filters can be applied 1) Source Site 2) Destination Site 3) DSCP 4) Service Provider 5) TCA Metrics The URL format is:/op/pfrMonitoringExt/getDSCPvsUrTCAViaPost/startTime/endTime. Here are the sample queries:
  • /op/pfrMonitoringExt/getDSCPvsUrTCAViaPost/1475824562/1476429362 + PostBody -- Returns UnReachable events experienced by various DSCPs in a PfR controlled network

Sample PostBody:

{ "pfRLandingPageFilterDTO" : { "dSCPs" : { "dSCPs" :"5" } } }

POST Max Delay Vs DSCP Chart Reports

POST op/pfrMonitoringExt/getMaxDelayVsDSCPChartReportsViaPost/{startTime}/{endTime}

Provides a trend report of how DSCPs are affected by network Delay reported by PfR events.Provides a trend report of how DSCPs are affected by network Delay reported by PfR events. This call is over HTTP(s) POST where a filter object having one or more or none of the below filters 1) Source Site 2) Destination Site 3) DSCP 4) Service Provider 5) TCA Metrics The URL format is:/op/pfrMonitoringExt/getMaxDelayVsDSCPChartReportsViaPost/startTime/endTime Here are the sample queries:
  • /op/pfrMonitoringExt/getMaxDelayVsDSCPChartReportsViaPost/1475824562/1476429362 + PostBody -- Returns the unreachable events experienced by various DSCPs in a PfR controlled network

Sample PostBody:

{ "pfRLandingPageFilterDTO" : { "dSCPs" : { "dSCPs" :"5" } } }

POST Max Jitter Vs DSCP Chart Reports

POST op/pfrMonitoringExt/getMaxJitterVsDSCPChartReportsViaPost/{startTime}/{endTime}

Provides a trend report of how DSCPs are affected by Jitter variations reported by PfR events.This call is over HTTP(s) POST where a filter object having one or more or none of the below filters 1) Source Site 2) Destination Site 3) DSCP 4) Service Provider 5) TCA Metrics The URL format is:/op/pfrMonitoringExt/getMaxJitterVsDSCPChartReportsViaPost/startTime/endTime. Here are the sample queries:
  • /op/pfrMonitoringExt/getMaxJitterVsDSCPChartReportsViaPost/1475824562/1476429362 + PostBody -- Returns the trend report of how DSCPs are affected by Jitter variations reported by PfR events

Sample PostBody:

{ "pfRLandingPageFilterDTO" : { "dSCPs" : { "dSCPs" :"5" } } }

POST Max Packet Loss Vs DSCP Chart Reports

POST op/pfrMonitoringExt/getMaxPacketLossVsDSCPChartReportsViaPost/{startTime}/{endTime}

Provides a trend report of how DSCPs are affected by Packet Loss percentage reported by PfR events.This call is over HTTP(s) POST where a filter object having one or more or none of the below filters 1) Source Site 2) Destination Site 3) DSCP 4) Service Provider 5) TCA Metrics The URL format is:/op/pfrMonitoringExt/getMaxPacketLossVsDSCPChartReportsViaPost/startTime/endTime. Here are the sample queries:
  • /op/pfrMonitoringExt/getMaxPacketLossVsDSCPChartReportsViaPost/1475824562/1476429362 -- Returns a trend report of how DSCPs are affected by Packet Loss percentage reported by PfR events

Sample PostBody:

{ "pfRLandingPageFilterDTO" : { "dSCPs" : { "dSCPs" :"5" } } }

POST Pfr Event List

POST op/pfrMonitoringExt/getPfrEventListViaPost/{startTime}/{endTime}

Fetches a trend of PfR Events over a period of time for different PfR controlled Site Pairs. This call is over HTTP(s) POST where a filter object having one or more or none of the below filters 1) Source Site 2) Destination Site 3) DSCP 4) Service Provider 5) TCA Metrics The URL format is:/op/pfrMonitoringExt/getPfrEventListViaPost/startTime/endTime. Here are the sample queries:
  • /op/pfrMonitoringExt/getPfrEventListViaPost/1475824562/1476429362 + PostBody -- Returns the unreachable events experienced by various DSCPs in a PfR controlled network

Sample PostBody:

{ "pfRLandingPageFilterDTO" : { "dSCPs" : { "dSCPs" :"5" } } }

POST Service Provider Usage Vs DSCP Chart

POST op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/{startTime}/{endTime}/{topN}

Provides a snapshot view of how Service Providers are being utilized to carry traffic for various DSCPs. This call is over HTTP(s) POST where a filter object having one or more or none of the below filters 1) Source Site 2) Destination Site 3) DSCP 4) Service Provider 5) TCA Metrics. The URL format is:/op/pfrMonitoringExt/getMaxJitterVsDSCPChartReportsViaPost/startTime/endTime. Here are the sample queries:
  • /op/pfrMonitoringExt/getMaxJitterVsDSCPChartReportsViaPost/1475824562/1476429362 + PostBody -- Returns a snapshot view of how Service Providers are being utilized to carry traffic for various DSCPs

Sample PostBody:

{ "pfRLandingPageFilterDTO" : { "dSCPs" : { "dSCPs" :"5" } } }

System Settings

System Settings

Resource Description API Version
DELETE WLAN FTP Server

DELETE op/settings/servers/ftpServers/{serverName}

Deletes existing FTP server.
GET Alarms notification settings

GET op/settings/notification/alarmCategories

Retrieves current alarms notification settings
GET Basic parameters for the configuration archive

GET op/settings/inventory/configArchiveBasic

Retrieves basic parameters for the configuration archive, such as protocol, timeout value, number of configuration versions to store, and so forth.
GET Configuration for Automatic Deletion Periods of Alarms

GET op/settings/alarms/alarmDeletionPeriods

Retrieves configuration for automatic deletion periods of alarms
GET Current general logging options

GET op/settings/logging/generalLoggingOptions

Retrieves current general logging options with log modules names in alphabet case insensitive order.
GET Data Pruning Configuration

GET op/settings/data/pruneDataConfig/{tableName}

Retrieves data pruning configuration for particular table.
GET Data Pruning Configuration for Category

GET op/settings/data/pruneDataConfigsByGroup/{category}

Retrieves data pruning configurations for given category.
GET Data Retention Periods

GET op/settings/data/dataRetentionPeriods

Retrieves data retention periods configured.
GET List of WLAN FTP Servers

GET op/settings/servers/ftpServers

Retrieves the list of FTP servers.
GET Log file names

GET op/settings/logging/logFileNames

Retrieves names of log files used by each logger category.
GET Mail Server settings

GET op/settings/notification/mailServer

Retrieves current Mail Server configuration
GET SNMP settings

GET op/settings/logging/snmpSettings

Retrieves SNMP settings.
GET Severity and Auto Clear Config

GET op/settings/alarms/severityAutoClearConfig

Retrieves existing configuration for alarms. Returns tree of alarm types groups containing all alarms with their severities and auto clear ages if configured.
GET System log settings

GET op/settings/logging/sysLogSettings

Retrieves system log settings.
POST Add WLAN FTP Server

POST op/settings/servers/ftpServers

Adds new FTP server.
PUT Update Configuration for Automatic Deletion Periods of Alarms

PUT op/settings/alarms/alarmDeletionPeriods

Updates configuration for automatic deletion periods of alarms
PUT Update Data Pruning Configuration

PUT op/settings/data/pruneDataConfig/{tableName}

Updates data pruning configuration for particular table.
PUT Update Data Retention Periods

PUT op/settings/data/dataRetentionPeriods

Updates configuration of data retention periods.
PUT Update Mail Server settings

PUT op/settings/notification/mailServer

Updates current Mail Server configuration
PUT Update SNMP settings

PUT op/settings/logging/snmpSettings

Updates SNMP settings.
PUT Update Severity and Auto Clear Config

PUT op/settings/alarms/severityAutoClearConfig

Updates alarm settings for passed types changing severities and auto clear ages.
PUT Update WLAN FTP Server

PUT op/settings/servers/ftpServers

Updates an existing FTP server. The server name attribute must match the existing server to be modified, and cannot be changed.
PUT Update alarms notification settings

PUT op/settings/notification/alarmCategories

Updates current alarms notification settings
PUT Update basic parameters for the configuration archive

PUT op/settings/inventory/configArchiveBasic

Updates basic parameters for the configuration archive, such as protocol, timeout value, number of configuration versions to store, and so forth.
PUT Update general logging options

PUT op/settings/logging/generalLoggingOptions

Updates general logging options for passed arguments.
PUT Update system log settings

PUT op/settings/logging/sysLogSettings

Updates system log settings.

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.

User Defined Field Management

The User Defined Field Management services provide operations to query, create, update and delete user tag definitions

Resource Description API Version
GET User Defined Field Definition

GET data/UserDefinedFieldDefinition

Provides a view of the User Defined Field Definitions of the system
PUT Delete User Defined Field Definition

PUT op/udfService/deleteUserTagDefinition

An operation to delete User Defined Field definitions
PUT Import User Defined Field Definition

PUT op/udfService/importUserTagDefinition

An operation to create or update User Defined Field definitions.

User Management Service

Provides services to create, retrieve, update and delete users

Resource Description API Version
DELETE Delete user

DELETE op/userManagement/users

Deletes a user
GET Get user groups

GET op/userManagement/userGroups

Returns list of user groups
GET Get users

GET op/userManagement/users

Returns list of users
POST Create user

POST op/userManagement/users

Creates a new user
PUT Update user

PUT op/userManagement/users

Updates an existing user. User name is used to identify the user to be edited

VNF Provisioning

Provides for operations to register and deploy VNFs (Virtual Network Functions) on NfVOS.

Resource Description API Version
GET Get Bridges

GET op/nfv/getBridges

Get bridges.
GET Get Deployments

GET op/nfv/getDeployments

Get VNF deployments.
GET Get Device Details

GET op/nfv/deviceDetails

Get device details.
GET Get OVS Bridges

GET op/nfv/getOvsBridges

Get OVS bridges.
GET Get Services

GET op/nfv/getServices

Get services from NfVOS.
POST Add Bridge

POST op/nfv/addBridge

Add a bridge.
POST Add Device

POST op/virtual/addDevice

Add a device.
POST Create OVS Bridge

POST op/nfv/createOvsBridge

Create an OVS bridge.
POST Delete Bridge

POST op/nfv/deleteBridge

Delete a bridge.
POST Delete OVS Bridge

POST op/nfv/deleteOvsBridge

Delete an OVS bridge.
POST Deploy Service

POST op/nfv/deploy

Deploy a service on NfVOS.
POST Register Service

POST op/nfv/register

Register a service on NfVOS.
POST Un-Deploy Service

POST op/nfv/undeploy

Undeploy a service on NfVOS.
POST Un-Register Service

POST op/nfv/unregister

Unregister a service on NfVOS.
PUT Update Bridge

PUT op/nfv/updateBridge

Update Bridge
PUT Update OVS Bridge

PUT op/nfv/updateOvsBridge

Update OVS Bridge

Virtual Domains Management Service

Provides services to create, retrieve, update and delete virtual domains

Resource Description API Version
Represents an Access Point (Autonomous, Unified or Thirdparty) associated with a virtual domain.
Represents a Location or User Defined group assigned to a current virtual domain. Network devices assigned to dynamic groups will be associated with the virtual domain automatically. This API is not intended for ROOT-DOMAIN, for ROOT-DOMAIN the API returns all groups including Device Type groups.
Represents a Location or User Defined group explicitly assigned to a current virtual domain. This API is not intended for ROOT-DOMAIN, for ROOT-DOMAIN the API returns all groups including Device Type groups.
Represents a Network Device associated with a virtual domain.
Represents a Site Map associated with a virtual domain.
Represents a Virtual Element associated with a virtual domain.
Deletes an existing virtual domain. Fully qualified domain name is used to identify the domain to be deleted
Returns the list of virtual domains. The parentDomainName request parameter can be used to return all subdomains of a particular domain.
Creates a new virtual domain
Updates existing virtual domain. Fully qualified domain name is used to identify the domain to be edited

Virtual Image Repository

Provides operations to query and manage the Virtual Image Repository

Resource Description API Version
DELETE Delete Image by id

DELETE op/image/id

Delete the image with the supplied ID
GET List Image by id

GET op/image/list/id

List the details of the image with the given ID
GET List Images

GET op/image/list

List the details of all NFV images in PI
GET List Images by family

GET op/image/list/family

List the details of all NFV images with the given family name
GET List Physical Images

GET op/image/list/physical

List all Physical images in the repository
GET List Virtual Images

GET op/image/list/virtual

List all Virtual images in the repository
POST Add Image

POST op/image/add

Add an image file to the repository
POST Deploy Configuration

POST op/image/deployConfigure

Configure the deployment with the provided details

WLAN Provisioning

Provides for operations to retrieve, create, modify, and delete interfaces, WLAN profiles, and AP groups.

Resource Description API Version
GET Wlan Profiles

GET data/WlanProfiles

Provides information about WLANs present on controllers managed by this system.
GET Wlan Templates

GET data/WlanTemplates

Provides information about WLAN templates stored on this system.
DELETE Delete AP Group

DELETE op/wlanProvisioning/apGroup

Schedules a job to delete an AP group from a Wlan Controller.
DELETE Delete Interface

DELETE op/wlanProvisioning/interface

Schedules a job to delete an interface from a Wlan Controller.
DELETE Delete Interface Group

DELETE op/wlanProvisioning/interfaceGroup

Schedules a job to delete an interface group from a Wlan Controller.
DELETE Delete WLAN Profile

DELETE op/wlanProvisioning/wlanProfile

Schedules a job to delete a WLAN profile from a Wlan Controller.
DELETE Delete Wlan Template

DELETE op/wlanProvisioning/wlanTemplate

Removes a WLAN template from the server.
POST Create AP Group

POST op/wlanProvisioning/apGroup

Schedules a job to create an AP group on a Wlan Controller.
POST Create Interface

POST op/wlanProvisioning/interface

Schedules a job to create an interface on a Wlan Controller.
POST Create Interface Group

POST op/wlanProvisioning/interfaceGroup

Schedules a job to create an interface group on a Wlan Controller.
POST Create Wlan Template

POST op/wlanProvisioning/wlanTemplate

Creates a WLAN template on the server.
PUT Deploy Wlan Template

PUT op/wlanProvisioning/deployTemplate

Schedules a job to deploy a WLAN template onto a Wlan Controller, creating a WLAN profile.
PUT Modify AP Group

PUT op/wlanProvisioning/apGroup

Schedules a job to modify an existing AP group on a Wlan Controller. The apGroupName attribute must match the existing AP group to be modified, and cannot be changed.
PUT Modify Interface

PUT op/wlanProvisioning/interface

Schedules a job to modify an existing interface on a Wlan Controller. The interfaceName attribute must match the existing interface to be modified, and cannot be changed.
PUT Modify Interface Group

PUT op/wlanProvisioning/interfaceGroup

Schedules a job to modify an existing interface group on a Wlan Controller. The interfaceGroupName attribute must match the existing interface group to be modified, and cannot be changed.
PUT Modify Wlan Template

PUT op/wlanProvisioning/wlanTemplate

Modifies an existing WLAN template on the server. The template name must match an existing template.

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 the latest polled client statistics data. 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 load 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.
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 CPU Utilizations

GET data/HistoricalWLCCPUUtilizations

Represents the historical CPU utilization information collected from WLAN controllers in past 24 hours.
GET Historical Wireless Lan Controller Memory Utilizations

GET data/HistoricalWLCMemUtilizations

Represents the historical memory utilization information collected from WLAN controllers in past 24 hours.
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 load statistics information for radio interfaces of lightweight wireless access points collected from WLAN controllers. Note that when access points are in a dissociated state, the radio interface statistics presented by the RFLoadStats resource is not collected from WLAN controllers. When queried, the API presents information from the latest successful data collection event.
Represents the latest statistics information for radio interfaces of lightweight wireless access points collected from WLAN controllers. Note that when access points are in a dissociated state, the radio interface statistics presented by the RFStats resource is not collected from WLAN controllers. When queried, RFStats presents information from the latest successful data collection event. Because radio interface statistics were not collected, the API will present an empty result for disassociated access point radio interfaces. If the dissociation(s) occurred within the last 24 hours, the data/HistoricalRFStats API resource may have more data.
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 Third Party Access Point Summary

GET data/ThirdpartyAccessPoints

Represents a third party access point. It provides device attributes such as type, version, associated controller, number of associated clients, etc.
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. Note: the API resource may return Meraki devices as access points. You can filter them out by adding "type=ne(MerakiAccessPoint)" query string.
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. Note: the API resource may return Meraki devices as access points. You can filter them out by adding "type=isNull()" query string.
GET Wireless Lan Controller CPU Utlizations

GET data/WLCCPUUtilizations

Represents the latest CPU utilization collected from a WLAN controller.
GET Wireless Lan Controller Details

GET data/WlanControllerDetails

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

GET data/WLCMemoryUtilizations

Represents the latest memory utilization collected from 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.