Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

REST API Resources

AAA/TACACS+ Servers Operations Service

Provides services to AAA servers operations

Resource Description
DELETE Delete Server Delete existing TACACS+ server
GET List Servers Read all TACACS+ servers
POST Add Server Add new TACACS+ server
PUT Update Server Update an existing TACACS+ server. The serverIp attribute must match the existing server to be modified, and cannot be changed.

API Health Service

Provides services to monitor and diagnose API performance and usage.

Resource Description
GET API Health Record Represents API performance and diagnostic information.
GET API Response Time Summary Represents summarized information about response times for each service.
GET API Calls Per Client 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 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 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 Returns the list of services for which there are ApiHealthRecords.

Access Point Operations

Operations to delete and modify access points

Resource Description
PUT Delete Unified Access Point An operation to delete unified AP and third party AP.
PUT Modify Unified Access Point Modifies an Access Point's name, location, controller affinity, or admin status.

BNG IP Pool Statistics

The BNG IP Pool Statistics API provides performance data of Ip Pool. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one - "BNG IP Pool Details". The response will contain the exact URL for the next method ("BNG IP Pool Available Metrics").
  • BNG IP Pool Details
  • BNG IP Pool Available Metrics
  • BNG IP Pool Metric Data
Resource Description
GET BNG IP Pool Available Metrics
Fetches all metrics that are relevant for the specific ip pool, as well as the URL of the next step (BNG IP Pool Metric Data) that is available under the "url" element.
Example: op/statisticsService/me1200qos/metrics?deviceName=ME-1200-1& ifName=GigabitEthernet 1/3.ECE.40&evcId=1&tableName=EVC
GET BNG IP Pool Details
Fetches the BNG IP Pool basic details, in addition to the URL for the next step that is available under the "metricsLink" element.
Examples:
op/statisticsService/bngIp
op/statisticsService/bngIp?.full=true&device=10.56.23.51
GET BNG IP Pool Metric Data
Fetches performance data of a given metric or metrics for a specific ip pool over a given period.
Examples:
op/statisticsService/bngIp/metrics/used?startTime=1499071288516&endTime=1499074888516& metricDataType=TIME_SERIES&device=10.56.23.51&poolName=IPOE
op/statisticsService/bngIp/metrics/used,free?startTime=1499071288516& endTime=1499074888516&metricDataType=TIME_SERIES&device=10.56.23.51&poolName=IPOE

BNG Sessions Statistics

The BNG Sessions Statistics provides performance data of session. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one - "BNG Sessions Details". The response will contain the exact URL for the next method ("BNG Sessions Available Metrics").
  • BNG Sessions Details
  • BNG Sessions Available Metrics
  • BNG Sessions Metric Data
Resource Description
GET BNG Sessions Available Metrics
Fetches all metrics that are relevant for the session, as well as the URL of the next step ("BNG IP Pool Metric Data") that is available under the "url" element.
Example: op/statisticsService/bngIp/metrics?device=10.56.23.51&pointType=physical &sessionType=all
GET BNG Sessions Details
Fetches the BNG Sessions basic details, in addition to the URL for the next step that is available under the "metricsLink" element.
Examples:
op/statisticsService/bngSessions
op/statisticsService/bngSessions?.full=true&device=10.56.23.51
GET BNG Sessions Metric Data
Fetches performance data of a given metric or metrics for a specific session over a given period.
Example: op/statisticsService/bngSessions/metrics/up?pointType=physical& sessionType=all&device=10.56.23.51&metricDataType=TIME_SERIES& startTime=1499054544561&endTime=1499076144561

CEM Statistics

The CEM Statistics API provides performance data of CEM interfaces. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one – “CEM Details”. The response will contain the exact URL for the next method (“CEM Available Metrics”).
  • CEM Details
  • CEM Available Metrics
  • CEM Metric Data
Resource Description
GET CEM Available Metrics
Fetches all metrics that are relevant for a specific interface, as well as the URL of the next step (“Optical SFP Metric Data”) that is available under the "url" element.
Example: op/statisticsService/cem/metrics?deviceName=10.56.23.109& ifName=CEM-PG1&cemId=16001
GET CEM Details
Fetches the CEM interfaces basic details, in addition to the URL for the next step that is available under the "metricsLink" element.
Examples:
op/statisticsService/cem
op/statisticsService/cem?.full=true&device=10.56.23.109
GET CEM Metric Data
Fetches performance data of a given metric or metrics for a specific interface over a given period.
Example: op/statisticsService/cem/metrics/receivedRbits,receivedLbits?startTime=1498996800749& endTime=1499000400749&metricDataType=TIME_SERIES&deviceName=10.56.23.109& ifName=CEM-PG1&cemId=16001
OR TOP N performance data of a given metric for all the CEM interfaces over a given time period.
Example: op/statisticsService/cem/metrics/receivedRbits?startTime=1498996800749& endTime=1499000400749&metricDataType=TOP_N

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
GET CLI Configuration Templates CLI configuration templates.
DELETE Delete Configuration Template Deletes a template from the system.
DELETE Delete Configuration Template Folder Delete folder
GET Download Configuration Template
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 folders
GET List Configuration 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 Returns the list of device types you can specify for a CLI template.
POST Create Configuration Template Folder Create new folder
POST Upload Configuration Template 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
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.
PUT Deploy Configuration Template Through Job Deploy a template to a list of devices through Job. A job name will be returned. 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
PUT Modify Configuration Template Content Update template. Does not support Converged Access Templates (IOS-XE templates and templates created from them).

Circuit Statistics

The Circuit Statistics provides performance data of circuits. Using a step-by-step process, by providing only the circuit name, user can retrieve performance data for each of the counters available depending on the circuit type. Each rest call contains the url for the next rest call in the process, so the only method that the user needs to manually compose is the first one - Circuit Details. The response will already contain the exact url for the next method (Circuit Available Metrics). Statistics will be available once appropriate monitoring policy is enabled. The order of the rest calls is as follows:
  • Circuit Details
  • Circuit Available Metrics
  • Circuit Metric Data
Resource Description
GET Circuit Available Metrics
Fetches all the counters that are relevant for the circuit type, the counter type, and the url of the next step (Circuit Metric Data) that is available under the "url" element. Example: /op/statisticsService/circuits/metrics?circuitType=EVC&circuitId=16229216
GET Circuit Details
Fetches the circuit basic details, in addition to the url for the next step that is available under the "metricsLink" element. Example: /op/statisticsService/circuits?.full=true&circuitName=EvcLink_EthPwLink%23EPW_50.50.50.50
GET Circuit Links Metrics URLs
Fetches all Links that are relevant for a circuit name, and the url of the next step (Link Metric Data) that is available under the "url" element. Example: /op/statisticsService/circuits/links?circuitName=EvcLink_EthPwLink%23EPW_50.50.50.50
GET Circuit Metric Data
Fetches performance data of a given circuit and counter name. Example: /op/statisticsService/circuits/metrics/Ipslay1731AvgAvailability?maxResults=24&timeInterval=6&circuitType=EVC&circuitId=16229216

Clients

Provides information about wired and wireless clients.

Resource Description
GET Client Counts 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 Represents the detail view of a client. It provides attributes of client device, security information, connected device, traffic and session information. All information is collected in current or last session.
GET Client Sessions Represents detail view of client sessions. It provides device and session related attributes including security, connected device, session time, traffic, etc.
GET Client Summary Represents client view with information about the end points. It provides end point information such as MAC address, IP address, username, and status.
GET Client Traffic Information Represents clients traffic information collected during the last polling cycle.
GET Historical Client Counts Represents client count collected in last 24 hours with 5 minutes (default) interval. The dataset could be really big. When querying, you must use paged query or filtered by entity or time. Otherwise it could result in longer running query to affect system performance.
GET Historical Client Traffic Information Represents client traffic information collected in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying, you must use paged query or filtered by entity or time. Otherwise it could be resulted in longer running query to affect system performance.

Compliance Service

Provides service to compliance operations

Resource Description
GET Checks status of Check Job Checks status of Compliance Check Job
POST Add policy Creates custom policy
POST Add profile Creates profile and associates policy
POST Import policy Creates custom policy from XML
POST Schedule a Check Job Schedules a Compliance Check Job

Configuration Archive Service

Provides services for configuration file, diff and versions operations

Resource Description
GET Bulk export sanitized configuration archives 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 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 Configuration archive for device
GET Configuration versions and files list Represents information about the version of the configuration files
GET Configuration Diff Compute Running Configuration Diff. Currently supported only for router devices.
GET Download the sanitized configuration file Extract a sanitized configuration file (not applicable for config files with type VLAN and DATABASE)
GET Download the unsanitized configuration file Extract an unsanitized configuration file (not applicable for config files with type VLAN and DATABASE)

Credentials Service

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

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

Device Details

The Device Details category provides basic information about the managed devices:
  • Device summary and inventory information about devices.
  • Events and alarms in the system.
Resource Description
GET Alarms Alarm is a representation of the fault or change of state that occurred in the managed system; it could be resource or service and customer related. Alarms are associated with a group of events received from the managed resources, usually with the same source and category, indicating that such fault or event had occurred.
GET 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 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 It provides an aggregated view of all the available inventory information for the device.
GET 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, delete devices

Resource Description
GET Export Devices

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.

NBI filtering can be applied to the parameters. Use the GroupSpecification service 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 Delete one or more devices through a batch job
PUT Bulk Import

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

Credential Profiles Support

  • There is limitation on attaching imported device to the credential profile. If credentialProfileName parameter is given 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 Field (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 devices/exportDevices service
    • Find the UDF entry to be updated in the list
    • Assign the new value of the entry
    • Use devices/bulkImport service to save the change
PUT Delete Devices
Deprecated

This operation deletes devices in a synchronized way which may take a long time to respond. Use the Delete devices through job (POST /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.

Device Sensors Statistics

The Device Sensors Statistics API provides performance data of sensors. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one - "Device Sensors Details". The response will contain the exact URL for the next method ("Device Sensors Available Metrics").
  • Device sensors Details
  • Device sensors Available Metrics
  • Device sensors Metric Data
Resource Description
GET Device Sensors Available Metrics
Fetches all sensors for a specific device, as well as the URL of the next step (“Device Sensors Metric Data”) that is available under the "url" element.
Examples:
op/statisticsService/sensors/metrics?device=10.56.23.63
op/statisticsService/sensors/metrics?device=10.56.23.63&sensorType=Watts
Valid sensor types:
Other, Unknown, VoltsAC, VoltsDC, milliAmps, Watts, Hertz, Celsius, PercentRH, Rpm, Cmm, Truthvalue, SpecialEnum, DBm
GET Device Sensors Details
Fetches the Device sensors basic details, in addition to the URL for the next step that is available under the "metricsLink" element.
Example: op/statisticsService/sensors
GET Device Sensors Metric Data
Fetches up to date sensors performance data for a specific device.
Example:
op/statisticsService/sensors/metrics/sensorValue?metricDataType=TOP_N&device=10.56.23.63

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
DELETE Delete device or port 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 list of group rules. Only Location and Network Device groups are supported.
PUT Assign devices to a group Statically assign list of devices to a group (devices are listed by device IDs or IPs). Only Location and 'User Defined' Device groups are supported.
PUT Assign interfaces to a group Statically assign list of interfaces to given port group . Only 'User Defined' and 'WAN Interfaces' port groups are supported.
PUT Create or update device or port group Create or update a device or port group. Only Location and 'User Defined' Device groups and 'User Defined' port groups are supported.
PUT Remove devices from a group 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 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 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
GET Device Groups
Deprecated

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

This provides information about the hierarchy of device type groups. Note that internally, DeviceGroups are type of "Group", and thus all children will be of the generic type "subGroup".
GET Group Specification Provides a view of group specific information of devices. Use this service to query or navigate groups
GET 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
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 Provides alarm summary information including: total number of alarms, number of alarmed devices, number of alarmed sites, number of alarmed APs and number of alarmed Clients.
GET Device Groups Returns list of Device Type groups, including the count of alarms of each severity for each group.
GET Location Groups 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."
GET User Defined Groups 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.

IPSLA (ICMP JITTER) Statistics

The IPSLA (ICMP JITTER) Statistics API provides performance data of L3 ICMP Jitter probes. Using a step-by-step process, by providing the device,targetIp and vrfName, the user can retrieve performance data for each of the metrics available. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one – “IPSLA Probe Details”. The response will contain the exact URL for the next method (“IPSLA Available Probe Metrics”).
  • IPSLA (ICMP JITTER) Probe Details
  • IPSLA (ICMP JITTER) Available Probe Metrics
  • IPSLA (ICMP JITTER) Probe Metric Data
Resource Description
GET IPSLA (ICMP JITTER) Available Probe Metrics
Fetches all metrics that are relevant for a specific probe, as well as the URL of the next step (“IPSLA (ICMP JITTER) Probe Metric Data”) that is available under the "url" element.
Example: op/statisticsService/ipsla/metrics?device=10.56.23.49&targetIp=130.1.2.1& vrfName=L3VPN_RK_01&ipslaType=ICMP Echo&tos=0
GET IPSLA (ICMP JITTER) Probe Details
Fetches the IPSLA probes details, in addition to the URL for the next step that is available under the "metricsLink" element.
Example: op/statisticsService/ipsla?.full=true&device=10.56.23.49& targetIp=130.1.2.1&vrfName=L3VPN_RK_01
GET IPSLA (ICMP JITTER) Probe Metric Data
Fetches performance data of a given metric or metrics for a specific probe over a given period.
Examples:
op/statisticsService/ipsla/metrics/jitterforward?startTime=1498991848163& endTime=1498995448163&metricDataType=TIME_SERIES&device=10.56.23.49& targetIp=130.1.2.1&vrfName=L3VPN_RK_01&tos=0

op/statisticsService/ipsla/metrics/stats?metrics=jitterforward,delayForward,lossforward& startTime=1498991848163&endTime=1498995448163&metricDataType=STATS& device=10.56.23.49&targetIp=130.1.2.1&vrfName=L3VPN_RK_01&tos=0

OR TOP N performance data of a given metric for all probes over a given time period.
Example: op/statisticsService/ipsla/metrics/jitterforward?startTime=1498991848163& endTime=1498995448163&metricDataType=TOP_N

IPSLA Y1731 Statistics

The IPSLA Y1731 Statistics API provides performance data of Y.1731 probes. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one - "ISLA Y1731 Probe Details". The response will contain the exact URL for the next method ("IPSLA Y1731 Available Probe Metrics").
  • IPSLA Y1731 Probe Details
  • IPSLA Y1731 Available Probe Metrics
  • IPSLA Y1731 Probe Metric Data
Resource Description
GET IPSLA Y1731 Available Probe Metrics
Fetches all metrics that are relevant for a specific probe, as well as the URL of the next step ("IPSLA Y1731 Probe Metric Data") that is available under the "url" element.
Example: op/statisticsService/y1731/metrics?device=10.56.23.109& sourceMpid=MPID 151&targetMpid=MPID 150&cfmDomain=L5&evc=e713& operationType=Delay
GET IPSLA Y1731 Probe Details
Fetches the IPSLA Y1731 probes details, in addition to the URL for the next step that is available under the "metricsLink" element.
Example: op/statisticsService/y1731
GET IPSLA Y1731 Probe Metric Data
Fetches performance data of a given metric for a specific probe over a given period.
Example: op/statisticsService/y1731/metrics/delayforward?startTime=1498986621324& endTime=1498990221324&metricDataType=TOP_N

OR TIME SERIES performance data of a given metric for all probes over a given time period.
Example: op/statisticsService/y1731/metrics/delayforward?startTime=1498986621324& endTime=1498990221324&metricDataType=TIME_SERIES&device=10.56.23.109& sourceMpid=MPID 151&targetMpid=MPID 150&cfmDomain=L5&evc=e713& operationType=Delay

Interface CRC Errors Statistics

The Interface CRC Statistics API provides performance data of errors. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one – “Interface CRC Details”. The response will contain the exact URL for the next method (“Interface CRC Available Metrics”).
  • Interface CRC Details
  • Interface CRC Available Metrics
  • Interface CRC Metric Data
Resource Description
GET Interface CRC Errors Available Metrics
Fetches all metrics that are relevant for a specific interface, as well as the URL of the next step (“Interface CRC Metric Data”) that is available under the "url" element.
Example: op/statisticsService/interfacecrc/metrics?device=10.56.23.63&ifName=BDI519
GET Interface CRC Errors Details
Fetches the Interface CRC errors basic details, in addition to the URL for the next step that is available under the "metricsLink" element.
Example: op/statisticsService/interfacecrc
GET Interface CRC Errors Metric Data
Fetches performance data of a given metric or metrics for a specific interface over a given period.
Examples:
op/statisticsService/interfacecrc/metrics/crcErrorsCount?startTime=1499153553628& endTime=1499157153628&metricDataType=TIME_SERIES&device=10.56.23.63& ifName=BDI519

op/statisticsService/interfacecrc/metrics/stats?metrics=crcErrorsCount& startTime=1499153553628&endTime=1499157153628&metricDataType=STATS& device=10.56.23.63&ifName=BDI519

OR TOP N performance data of a given metric for all interfaces over a given time period.
Example: op/statisticsService/interfacecrc/metrics/crcErrorsPercentage?startTime=1499153553628& endTime=1499157153628&metricDataType=TOP_N

Job Operations

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

Resource Description
GET Job Summary 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

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 Disable the trigger permanently. The canceled job cannnot be resumed using "Resume A Job" service
PUT Cancel A Job running instance Stop a running instance of a job.
PUT Resume A Job Re-enable the trigger of a suspended job.
PUT Suspend A Job 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.

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
GET Core Dumps Returns the number of application core dumps present on the server.
GET Disk Usage and Capacity Returns capacity and usage information for the volumes present on the application's server.
GET Licenses Returns license information about the application.
GET Uptime Returns uptime information as well as information about the application and the server it runs on.
GET Version Returns the version of the application.

Me1200 Quality of Service Statistics

The Me1200 Quality of Service Statistics provides performance data of QoS Performance of Interfaces. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one - "Me1200 Quality of Service Details". The response will contain the exact URL for the next method ("Me1200 Quality of Service Available Metrics").
  • Me1200 Quality of Service Details
  • Me1200 Quality of Service Available Metrics
  • Me1200 Quality of Service Metric Data
Resource Description
GET Me1200 Quality of Service Available Metrics
Fetches all metrics that are relevant for the EVC, as well as the URL of the next step (“Me1200 Quality of Service Metric Data”) that is available under the "url" element.
Example: op/statisticsService/me1200qos/metrics?deviceName=ME-1200-1& ifName=GigabitEthernet 1/3.ECE.40&evcId=1&tableName=EVC
GET Me1200 Quality of Service Details
Fetches the Me1200 Quality of Service of EVCs basic details, in addition to the URL for the next step that is available under the "metricsLink" element.
Examples:
op/statisticsService/me1200qos
op/statisticsService/me1200qos?.full=true&device=10.56.23.109
GET Me1200 Quality of Service Metric Data
Fetches performance data of a given metric or metrics for a specific interface and EVC over a given period.
Examples:
op/statisticsService/me1200qos/metrics/stats?metrics=tx_yellow_framerate,rx_yellow_framerate& startTime=1498995959350&endTime=1498999559350&metricDataType=STATS& deviceName=ME-1200-1&ifName=GigabitEthernet 1/3.ECE.40& evcId=1&tableName=EVC

op/statisticsService/me1200qos/metrics/txyellowbitrate,rxyellowbitrate?startTime=1498995959350 &endTime=1498999559350&metricDataType=TIME_SERIES&deviceName=ME-1200-1& ifName=GigabitEthernet 1/3.ECE.40&evcId=1&tableName=EVC

Network Topology Layout

Resource Description
GET Get Global Topology Layout retrieves the global topology layout for a given group
POST Save Global Topology Layout saves the global toplogy layout per group

Optical Ethernet Statistics

The optical pm statistics API provides performance data of optical device performance. Each REST call contains the URL for the next REST call in the process.
  • Optical Ethernet Resources
  • Optical Ethernet Metric
  • Optical Ethernet PerformanceData
Resource Description
GET Optical Ethernet Metrics
Fetches the URLs for various metrics of an Interface
Example: statisticsService/opticalethernet/metrics?device=10.56.23.109& ifName=GigabitEthernet0/6&pmInterval=15-MIN&startTime=1498995120297& endTime=1498998320297
GET Optical Ethernet Performance Data
Fetches the metric data for an Interface
Example: op/statisticsService/opticalethernet/metrics/{metrics}?

TIME SERIES performance data of a given metric for all probes over a given time period.
Example: op/statisticsService/opticalphysical/metrics/Voltage,RxPower,Temperature?startTime=1498986621324& endTime=1498990221324&ifName=TIME_SERIES&device=10.56.23.109& pmInterval=1-DAY
GET Optical Ethernet Resources
Fetches the details of Interfaces
Example: op/statisticsService/opticalethernet

Optical OTN Data Statistics

Resource Description
GET Optical OTN Metrics
Fetches the URLs for various metrics of an Interface
Example: statisticsService/opticalotn/metrics?device=10.56.23.109& ifName=GigabitEthernet0/6&pmInterval=15-MIN&startTime=1498995120297& endTime=1498998320297
GET Optical OTN Performance Data
Fetches the metric data for an Interface
Example: op/statisticsService/opticalotn/metrics/{metrics}?

TIME SERIES performance data of a given metric for all probes over a given time period.
Example: op/statisticsService/opticalotn/metrics/Voltage,RxPower,Temperature?startTime=1498986621324& endTime=1498990221324&ifName=TIME_SERIES&device=10.56.23.109& pmInterval=1-DAY
GET Optical OTN Resources
Fetches the details of Interfaces
Example: op/statisticsService/opticalotn

Optical Physical Statistics

The optical pm statistics API provides performance data of optical device performance. Each REST call contains the URL for the next REST call in the process.
  • Optical Physical Resources
  • Optical Physical Metric
  • Optical Physical Performance Data
Resource Description
GET Optical Physical Metrics
Fetches the URLs for various metrics of an Interface
Example: statisticsService/opticalphysical/metrics?device=10.56.23.109& ifName=GigabitEthernet0/6&pmInterval=15-MIN&startTime=1498995120297& endTime=1498998320297
GET Optical Physical Performance Data
Fetches the metric data for an Interface
Example: op/statisticsService/opticalphysical/metrics/{metrics}?

TIME SERIES performance data of a given metric for all probes over a given time period.
Example: op/statisticsService/opticalphysical/metrics/Voltage,RxPower,Temperature?startTime=1498986621324& endTime=1498990221324&ifName=TIME_SERIES&device=10.56.23.109& pmInterval=1-DAY
Example: /webacs/api/v2/op/statisticsService/opticalphysical/metrics/{}
GET Optical Physical Resources
Fetches the details of Interfaces
Example: op/statisticsService/opticalphysical

Optical SFP Statistics

The Optical SFP DOM Statistics API provides performance data of SFP module. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one - "Optical SFP Details". The response will contain the exact URL for the next method ("Optical SFP Available Metrics").
  • Optical SFP Details
  • Optical SFP Available Metrics
  • Optical SFP Metric Data
Resource Description
GET Optical SFP Available Metrics
Fetches all metrics that are relevant for the SFP module, as well as the URL of the next step ("Optical SFP Metric Data") that is available under the "url" element. Example: op/statisticsService/opticalSfp/metrics?device=10.56.23.27&ifName=GigabitEthernet0/6
GET Optical SFP Details
Fetches the Optical SFP module details, in addition to the URL for the next step that is available under the "metricsLink" element.
Examples:
op/statisticsService/opticalSfp
op/statisticsService/opticalSfp?.full=true&device=10.56.23.27
GET Optical SFP Metric Data
Fetches performance data of a given metric or metrics, for a specific interface over a given period.
Examples:
op/statisticsService/opticalSfp/metrics/stats?metrics=Voltage,RxPower,Temperature& startTime=1498995120297&endTime=1498998720297&metricDataType=STATS& device=10.56.23.27&ifName=GigabitEthernet0/6

op/statisticsService/opticalSfp/metrics/Voltage,RxPower,Temperature?startTime=1498995120297& endTime=1498998720297&metricDataType=TIME_SERIES&device=10.56.23.27& ifName=GigabitEthernet0/6

Optical Sonet SDH Statistics

Resource Description
GET Optical Sonet SDH Metrics
Fetches the URLs for various metrics of an Interface
Example: op/statisticsService/opticalsonetsdh/metrics/Voltage,RxPower,Temperature?startTime=1498986621324& endTime=1498990221324&ifName=TIME_SERIES&device=10.56.23.109& pmInterval=1-DAY
GET Optical Sonet SDH Performance Data
Fetches the metric data for an Interface
Example: op/statisticsService/opticalsonetsdh/metrics/{metrics}?

TIME SERIES performance data of a given metric for all probes over a given time period.
Example: op/statisticsService/opticalsonetsdh/metrics/Voltage,RxPower,Temperature?startTime=1498986621324& endTime=1498990221324&ifName=TIME_SERIES&device=10.56.23.109& pmInterval=1-DAY
GET Optical Sonet SDH Resources
Fetches the details of Interfaces
Example: op/statisticsService/opticalsonetsdh

Plug and Play

Provides operations related to Plug And Play

Resource Description
DELETE Delete Pnp Profile Deletes the exisiting Pnp profiles.
GET Get All Profile Instances of a PnP Profile 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 Takes PnP Profile Name and Instance Name as rest parameters. It returns the Profile Instance.
GET Read All Pnp Profiles Read all the pnp profiles inside a folder
GET Read Pnp Profile Get the attributes of the given pnp profile
POST Create Pnp Profile Creates Pnp profiles
POST Create Update PnP Status
POST Create or Update Profile Instances of a PnP Profile 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 Updates the existing pnp profiles

Quality of Service Statistics

The Quality of Service Statistics API provides the QoS Performance of Interfaces, QoS polices and QoS classes. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one - "Quality of Service Policy Details". The response will contain the exact URL for the next method ("Quality of Service Policy Metrics").
  • Quality of Service Policy Details
  • Quality of Service Available Policy Metrics
  • Quality of Service Policy Metric Data
Resource Description
GET Quality of Service Available Policy Metrics
Fetches all metrics that are relevant for a given instance identified by: device, interface Name, policy, classmap and direction, as well as the URL of the next step (“Quality of Service Policy Metric Data”) that is available under the "url" element.
Example: op/statisticsService/qos/metrics?device=10.56.23.25&ifName=GigabitEthernet0/10& policy=testQosDerechoMR3Policy&classmap=testQosDerechoMR3&direction=input
GET Quality of Service Policy Details
Fetches the Quality of Service instances basic details, in addition to the URL for the next step that is available under the "metricsLink" element.
Example: op/statisticsService/qos
GET Quality of Service Policy Metric Data
Fetches performance data of a given metric for specific policy over a given period.
Example: op/statisticsService/qos/metrics/droprate?startTime=1498989265013& endTime=1498992865013&metricDataType=TIME_SERIES&device=10.56.23.25& ifName=GigabitEthernet0/10&policy=testQosDerechoMR3Policy& classmap=testQosDerechoMR3&direction=input

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
GET Get Available Report Templates
This URL is used to get all the saved report templates. It returns an array of information about the available saved report templates.

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

GET Get a Report
This URL is used to retrieve the report data for a report that was previously generated from an asynchronous call of the reportService/report URL, or returns the latest result from a scheduled report generation.
GET Run a Report
This URL is used to generate reports from a specific saved report template and return the report output as an XML/JSON response.

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

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

GET Run a ZIP Report 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
GET Information about current platform
Retrieves the information about current platform
  • /op/update/platformInfo - return the MDF ID and the version of the underlying platform
GET Information about updates
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
GET All Border Routers
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
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
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
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
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
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
Retrieves the application performance statistics.
GET Application Top N Traffics
Retrieves the top N clients or server traffic statistics of an application or all applications. Here are the sample queries
  • /op/statisticsService/application/topNTraffics -- return the top 15 client traffics of all applications in the past 1 hour
  • /op/statisticsService/application/topNTraffics?nodeType=server -- return the top 15 server traffics of all applications in the past 1 hour
  • /op/statisticsService/application/topNTraffics?networkAwareType=2 -- return the top 15 client wired traffics of all applications in the past 1 hour
  • /op/statisticsService/application/topNTraffics?appId=1234 -- return the top 15 client traffics of the application with id 1234 in the past 1 hour
  • /op/statisticsService/application/topNTraffics?appId=1234,5678 -- return the top 15 client traffics of of the application with id 1234 and 5678 in the past 1 hour
GET Application Traffic Analysis
Retrieves the traffic analysis of an application.
GET Application Volume
Retrieves the application volume statistics in the list of application name and volume pairs. 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
GET Applications Number of Users
Retrieves the number of users of an application.
GET CPU Utilization Summary
Retrieves the device CPU utilization summary.
GET CPU Utilization Trend
Retrieves the device CPU utilization trend.
GET Cluster Details
Fetches the details of Clusters
GET Cluster Metric Data
Fetches the metric data for a Cluster
GET Cluster Metrics Supported
Fetches the URLs for various metrics of a Cluster
GET DSCP App Usage
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
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
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
Fetches the details of Datacenters
GET Datacenter Metric Data
No metrics are available for Datacenters
GET Datacenter Metrics Supported
No metrics are available for Datacenters
GET Device Availability
Retrieves the device availability summary for a given IP address.
GET Device Availability Message
Retrieves the device availability message.
GET Device Availability Summary

Retrieves the device availability summary.

GET Device Down Message
Retrieves the device down message.
GET Device Health Info
Retrieves the device health information.
GET Device Metric Data
Fetches the metric data for the device.
GET Device Metrics Supported
Fetches the URLs for various metrics of the device.
GET Device Port Summary
Retrieves the device port summary.
GET Device Reachability Status
Retrieves the device reachability status.
GET Device Resource
Fetches the basic details of devices and REST URL links to their children and metrics.
GET Host Details
Fetches the details of Hosts
GET Host Metric Data
Fetches the metric data for a Host
GET Host Metrics Supported
Fetches the URLs for various metrics of a Host
GET Interface Availability
Retrieve the interface availability.
GET Interface Availability Message
Retrieves the interface availability message.
GET Interface Availability Summary
Retrieves the interface availability summary.
GET Interface Details
Retrieves the interface details.
GET Interface Discards
Retrieves the interface discards.
GET Interface Down Message
Retrieves the interface down message.
GET Interface Errors
Retrieves the interface errors.
GET Interface Metric Data
Fetches the metric data for an Interface
GET Interface Metrics Supported
Fetches the URLs for various metrics of an Interface
GET Interface Resource
Fetches the basic details of interfaces and REST URL links to their children and metrics
GET Interface Status Summary
Retrieves the interface status summary.
GET Interface Utilization Summary
Retrieves the interface utilization summary.
GET Interface Utilizations
Retrieves the interface utilization.
GET Lisp Map Summary Trend
Retrieves the lisp map-cache size over time trend for a given device in the selected time interval
GET Memory Utilization Trend
Retrieves the device memory utilization trend.
GET OutStanding IMEs For Site
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 Refresh App Cache
Refresh App Cache
  • /op/pfrMonitoringExt/pfrMonitoringExt/refreshAppCache
GET Resource Types Supported
Fetches the various resources that support statistics service APIs
GET Site App Health
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
Retrieves system health statistics.
GET System Information
Retrieves system information statistics.
GET Threshold Violated Applications
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
Retrieves the top N application hosts.
GET Top N Applications
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
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
Retrieves the top N class map QOS statistics.
GET Top N Device CPU Utilization
Retrieves the top N device CPU utilization statistics.
GET Top N Device Cache
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
Retrieves the top N device memory utilization statistics.
GET Top N Device Temperature
Retrieves the top N device temperature statistics.
GET Top N Interface Errors
Retrieves the top N interface error statistics.
GET Top N Interface Utilization
Retrieves the top N interface utilization statistics.
GET Top N WAN Interface Issues
Retrieves the top N WAN interface issue statistics.
GET Top N WAN Interface Utilization
Retrieves the top N WAN interface utilization statistics.
GET TopNApplication Usage Over Time
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
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
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 VM Details Fetches the details of VMs
GET VM Metric Data
Fetches the metric data for a VM
GET VM Metrics Supported
Fetches the URLs for various metrics of a VM
GET WAN Utilization Over TimeRate For Link
Fetches WAN Utilization Over Time Rate For Link
GET WanUtilization Over Time For Link
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
Retrieves the worst N application hosts.
GET Worst N Application Locations
Retrieves the worst N application sites.
POST DSCP vs All TCA
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
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
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
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
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
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
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" } } }

TDM and Sonet Port Statistics

The TDM and Sonet Statistics API provides performance data of SONET and TDM ports (E1, T1, E3, T3, etc..). Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one – “TDM and Sonet Port Details”. The response will contain the exact URL for the next method (“TDM and Sonet Available Port Metrics”).
  • TDM and Sonet Port Details
  • TDM and Sonet Available Port Metrics
  • TDM and Sonet Port Metric Data
Resource Description
GET TDM and Sonet Available Port Metrics
Fetches all metrics that are relevant for the TDM and Sonet port, as well as the URL of the next step ("TDM and Sonet Port Metric Data") that is available under the "url" element. Example: op/statisticsService/tdm/PATH/metrics?device=10.56.23.63&ifName=E1 0/3/0
GET TDM and Sonet Port Details
Fetches the TDM and Sonet port details, in addition to the URL for the next step that is available under the "metricsLink" element.
Examples:
op/statisticsService/tdm
op/statisticsService/tdm?.full=true&device=10.56.23.63
GET TDM and Sonet Port Metric Data
Fetches performance data of a given metric, for a specific port over a given period.
Example: op/statisticsService/tdm/PATH/metrics/UASFE?startTime=1498993027544& endTime=1498996627544&metricDataType=TIME_SERIES&device=10.56.23.63& ifName=E1 0/3/0

Trap Receivers

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

Resource Description
DELETE Delete Trap Receiver Delete a trap destination configuration
GET List Trap Receivers Retrieve all existing trap destination configurations
POST Create Trap Receiver Create a trap destination configuration
PUT Update Trap Receiver Update a trap destination configuration

User Defined Field Management

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

Resource Description
GET User Defined Field Definition Provides a view of the User Defined Field Definitions of the system
PUT Delete User Defined Field Definition An operation to delete User Defined Field definitions
PUT Import User Defined Field Definition An operation to create or update User Defined Field definitions.

VNF Provisioning

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

Resource Description
GET Get Bridges Get bridges.
GET Get Deployments Get VNF deployments.
GET Get Device Details Get device details.
GET Get OVS Bridges Get OVS bridges.
GET Get Services Get services from NfVOS.
POST Add Bridge Add a bridge.
POST Add Device Add a device.
POST Create OVS Bridge Create an OVS bridge.
POST Delete Bridge Delete a bridge.
POST Delete OVS Bridge Delete an OVS bridge.
POST Deploy Service Deploy a service on NfVOS.
POST Register Service Register a service on NfVOS.
POST Un-Deploy Service Undeploy a service on NfVOS.
POST Un-Register Service Unregister a service on NfVOS.
PUT Update Bridge Update Bridge
PUT Update OVS Bridge Update OVS Bridge

Virtual Image Repository

Provides operations to query and manage the Virtual Image Repository

Resource Description
DELETE Delete Image by id Delete the image with the supplied ID
GET List Image by id List the details of the image with the given ID
GET List Images List the details of all NFV images in PI
GET List Images by family List the details of all NFV images with the given family name
GET List Physical Images List all Physical images in the repository
GET List Virtual Images List all Virtual images in the repository
POST Add Image Add an image file to the repository
POST Deploy Configuration 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
GET Wlan Profiles Provides information about WLANs present on controllers managed by this system.
GET Wlan Templates Provides information about WLAN templates stored on this system.
DELETE Delete AP Group Schedules a job to delete an AP group from a Wlan Controller.
DELETE Delete Interface Schedules a job to delete an interface from a Wlan Controller.
DELETE Delete Interface Group Schedules a job to delete an interface group from a Wlan Controller.
DELETE Delete WLAN Profile Schedules a job to delete a WLAN profile from a Wlan Controller.
DELETE Delete Wlan Template Removes a WLAN template from the server.
POST Create AP Group Schedules a job to create an AP group on a Wlan Controller.
POST Create Interface Schedules a job to create an interface on a Wlan Controller.
POST Create Interface Group Schedules a job to create an interface group on a Wlan Controller.
POST Create Wlan Template Creates a WLAN template on the server.
PUT Deploy Wlan Template Schedules a job to deploy a WLAN template onto a Wlan Controller, creating a WLAN profile.
PUT Modify AP Group 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 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 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 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
GET Autonomous AP Radio Details Represents a radio interface of an autonomous access point.
GET Client Statistics Represents client statistics data collected during the last polling cycle. The data represented here are the counters retrieved from controllers. The counters only get reset in new sessions.
GET Historical Client Statistics Represents client statistics collected in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying it, it is better to use paged query or filtered by client or time.
GET Historical Radio Interface 802.11 Counters in Last 24 Hours Represents 802.11 counters collected for radio interfaces of lightweight wireless access points in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying it, it is better to use paged query or filtered by AP or time.
GET Historical Radio Interface Statistics in Last 24 Hours Represents statistics for radio interfaces of lightweight wireless access points collected in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying it, it is better to use paged query or filtered by AP or time.
GET Historical Wireless Lan Controller CPU Utilizations Represents the historical CPU utilization information collected from WLAN controllers in past 24 hours.
GET Historical Wireless Lan Controller Memory Utilizations Represents the historical memory utilization information collected from WLAN controllers in past 24 hours.
GET Historical Wireless Lan Controller Utlizations
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 Represents detail information of a radio interfaces on lightweight access point.
GET Radio Interface 802.11 Counters Represents the latest 802.11 counters for radio interfaces of lightweight wireless access points collected from controllers.
GET Radio Interface Statistics Represents the latest statistics information for radio interfaces of lightweight wireless access points collected from WLAN controllers.
GET Radio Summary Represents a radio interface of an wireless access point.
GET Wireless Access Point Details Represents detail information of a wireless access points. It includes basic attributes, inventory, CDP, client and other information.
GET Wireless Access Point Summary Represents a wireless access point including both unified and autonomous. It provides device attributes such as type, version, association controller, number of associated client, etc.
GET Wireless Lan Controller CPU Utlizations Represents the latest CPU utilization collected from a WLAN controller.
GET Wireless Lan Controller Details Represents detail information about a WLAN controller.
GET Wireless Lan Controller Memory Utilizations Represents the latest memory utilization collected from a WLAN controller.
GET Wireless Lan Controller Summary Represents summary information about a WLAN controller.
GET Wireless Lan Controller Utlizations
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.

Y1731 Bins Statistics

The Y1731 Bins Statistics API counts the number of Frame Delay measurements falling within a specified range, over specified measurement intervals. Each REST call contains the URL for the next REST call in the process, so the only method that the user needs to manually compose is the first one - "Y1731 Bins Details". The response will contain the exact URL for the next method ("Y1731 Bins Available Metrics").
  • Y1731 Bins Details
  • Y1731 Bins Available Metrics
  • Y1731 Bins performance Data
Resource Description
GET Y1731 Bins Available Metrics
Fetches all metrics that are relevant for a specific probe, as well as the URL of the next step ("Y1731 Bins performance Data") that is available under the "url" element. Available metrics are: Delay (forward, backward, two way), Jitter (forward, backward, two way)
Example: op/statisticsService/y1731bins/metrics?device=10.56.23.64& sourceMpid=MPID%20134&targetMpid=MPID%20135&cfmDomain=level5&bridgeId=995& ipslaServiceName=level5&operationType=Delay
GET Y1731 Bins Details
Fetches the Y1731 probe details and number of bins, in addition to the URL for the next step that is available under the "metricsLink" element.
Example: op/statisticsService/y1731bins
GET Y1731 Bins performance Data
Fetches performance measurements of a given metric for a specific probe over a given period.
Example: op/statisticsService/y1731bins/metrics/stats?metrics=JitterBck& metricDataType=STATS&device=10.56.23.64&sourceMpid=MPID%20134& targetMpid=MPID%20135&cfmDomain=level5&bridgeId=995&operationType=Delay