Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager 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

API Health Service

Provides services to monitor and diagnose API performance and usage.

Resource Description API Version

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

Application Visibility and Control Service

Provides resources for discovering and controlling applications within the network.

Resource Description API Version

BNG IP Pool Statistics

The BNG IP Pool Statistics API provides performance data of Ip Pool. Each REST response 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 API Version

BNG Sessions Statistics

The BNG Sessions Statistics provides performance data of session. Each REST response 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 API Version

CEM Statistics

The CEM Statistics API provides performance data of CEM interfaces. Each REST response 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 API Version

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

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 API Version

Clients

Provides information about wired and wireless clients.

Resource Description API Version

Configuration Archive Service

Provides services for configuration file, diff and versions operations.

Resource Description API Version

Credentials Service

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

Resource Description API Version

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

Device Operations

An operation to add or update multiple devices using a batch job. Operations to create, update, and delete devices.

Resource Description API Version

Device Sensors Statistics

The Device Sensors Statistics API provides performance data of sensors. Each REST response 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 API Version

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

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

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 response 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 API Version

IPSLA Y1731 Statistics

The IPSLA Y1731 Statistics API provides performance data of Y.1731 probes. Each REST response 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 API Version

Interface CRC Errors Statistics

The Interface CRC Statistics API provides performance data of errors. Each REST response 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 API Version

Job Operations

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

Resource Description API Version

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

Managed Servers Operations

Provides operations related to retrieving information on servers managed by Operations Center and manipulating them (deactivate, delete).

Resource Description API Version

Me1200 Quality of Service Statistics

The Me1200 Quality of Service Statistics provides performance data of QoS Performance of Interfaces. Each REST response 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 API Version

Network Topology Layout

Resource Description API Version

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 API Version

Optical OTN Data Statistics

Resource Description API Version

Optical Physical OSNR Statistics

The optical pm OSNR statistics API provides performance data of optical device OSNR performance.
Resource Description API Version

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 API Version

Optical SFP Statistics

The Optical SFP DOM Statistics API provides performance data of SFP module. Each REST response 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 API Version

Optical Sonet SDH Statistics

Resource Description API Version

PTP Clock Statistics

The PTP (Precision Time Protocol) Statistics API displays PTP clocks information from the devices. Each REST response 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 - "PTP Clock Details". The response will contain the exact URL for the next method ("PTP Clocks Available Metrics").
  • PTP Clocks Details
  • PTP Clocks Available Metrics
  • PTP Clocks Performance Data
Resource Description API Version

PTP and SyncE settings

The PTP and SyncE Setting API allows to get and set different values related to the PTP and SyncE display in EPNM. EPNM collect different PTP and SyncE metrics from the devices. Based on these polled values EPNM classified the devices/ports PTP/SyncE status into 3 categories: OK, Degraded, Failure. This API enable the user to define which collected PTP/SyncE values will classified by EPNM as OK, which values will be classified as Degraded, and which values will be classified as a Failure.
  • Get PTP and SyncE settings
  • Set PTP clock class threshold
  • Set PTP servo state
  • Set SyncE quality level
  • Set UTC Offset
Resource Description API Version

Quality of Service Statistics

The Quality of Service Statistics API provides the QoS Performance of Interfaces, QoS polices and QoS classes. Each REST response 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 API Version

Rate Limits Management Service

Provides services to obtain and update rate limits

Resource Description API Version

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

Software Image Management Service

Provides services for import,distribute,activate and commit operations.

Resource Description API Version

Software Updates

Provides information about Software Updates.

Resource Description API Version

Statistics

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

Resource Description API Version

SyncE Statistics

The SyncE (Synchronized Ethernet) Statistics API displays different SyncE node metrics from the devices. Each REST response 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 - "SyncE Details". The response will contain the exact URL for the next method ("SyncE Available Metrics").
  • SyncE Details
  • SyncE Available Metrics
  • SyncE Performance Data
Resource Description API Version

System Settings

System Settings

Resource Description API Version

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 response 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 API Version

Trap Receivers

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

Resource Description API Version

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

User Management Service

Provides services to create, retrieve, update and delete users

Resource Description API Version

Virtual Domains Management Service

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

Resource Description API Version

Virtual Image Repository

Provides operations to query and manage the Virtual Image Repository

Resource Description API Version

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 response 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 API Version