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

# REST API Resources

- Jump To

Resource | Aggregation | Sorting | Filtering | Product Version | Was updated
--- | --- | --- | --- | --- | ---

## AAA/TACACS+ Servers Operations Service

Provides services manage AAA servers used by the appliance.

Resource | Description | API Version
--- | --- | ---
DELETE Delete Server DELETE op/aaa/tacacsPlusServer | Delete existing TACACS+ server. | v1 v2 v3 v4
GET List Servers GET op/aaa/tacacsPlusServer | Read all TACACS+ servers | v1 v2 v3 v4
POST Add Server POST op/aaa/tacacsPlusServer | Add new TACACS+ server | v1 v2 v3 v4
PUT Update Server PUT op/aaa/tacacsPlusServer | Update an existing TACACS+ server. Either serverIp or serverHostName must match the existing server to be modified, and cannot be changed. | v1 v2 v3 v4

## AP Onboarding Profile Management Service

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

Resource | Description | API Version
--- | --- | ---
GET Get AP onboarding profiles GET data/ApOnboardingProfile | Returns a list of AP onboarding profiles | v1 v2 v3 v4
DELETE Delete AP onboarding profiles DELETE op/apOnboarding/profile | Deletes AP Onboarding Profiles | v1 v2 v3 v4
POST Create AP onboarding profiles POST op/apOnboarding/profile | Adds AP Onboarding Profiles | v1 v2 v3 v4
PUT Modify AP onboarding profile PUT op/apOnboarding/profile | Updates AP Onboarding Profile | v1 v2 v3 v4

## API Health Service

Provides services to monitor and diagnose API performance and usage.

Resource | Description | API Version
--- | --- | ---
GET API Health Record GET data/ApiHealthRecords | Represents API performance and diagnostic information. | v1 v2 v3 v4
GET API Response Time Summary GET data/ApiResponseTimeSummary | Represents summarized information about response times for each service. | v1 v2 v3 v4
GET API Calls Per Client GET op/apiHealth/callsPerClient | Returns the IP addresses of all clients using either all services or the specified service, over the last 24 hours. | v1 v2 v3 v4
GET API Request Count Trend GET op/apiHealth/requestCountTrend | Reports the number of requests, grouped by day and HTTP status, for all services or a given service if specified, over the last seven days. | v1 v2 v3 v4
GET API Response Time Trend GET op/apiHealth/responseTimeTrend | For each request over the last 24 hours, shows the response time and the time the request was received, either for all services or for the specified service. | v1 v2 v3 v4
GET API Service Name List GET op/apiHealth/serviceNameList | Returns the list of services for which there are ApiHealthRecords. | v1 v2 v3 v4

## Access Point Operations

Operations to delete and modify access points.

Resource | Description | API Version
--- | --- | ---
GET Get Rx Neighbors GET op/apService/rxNeighbors | Return Rx Neighbors of an access point. Only Unified access points are supported. Note that the Prime Infrastructure does not cache/persist Rx neighbors due to volatility of this data. Thus the API resource queries the network to obtain Rx neighbors. API response time may depend on a network condition and is limited to 30 seconds. If it can not get response from a network device within this interval an error will be returned. | v1 v2 v3 v4
PUT Delete Access Points By IDs PUT op/apService/deleteById | An operation to delete unified AP and third party AP by IDs. | v1 v2 v3 v4
PUT Delete Access Points By Names PUT op/apService/deleteAp | An operation to delete unified AP and third party AP by names. | v1 v2 v3 v4
PUT Modify Unified Access Point PUT op/apService/accessPoint | Modifies an Unified Access Point. For API versions 1 and 2, all parameters should be specified. For API version 3, only the parameters desired to be changed and the ID need to be specified. | v1 v2 v3 v4

## Alarms Management Service

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

Resource | Description | API Version
--- | --- | ---
PUT Acknowledges Alarms PUT op/alarms/acknowledge | Acknowledges one or more alarms by provided identificators | v1 v2 v3 v4
PUT Annotates Alarms PUT op/alarms/annotate | Annotates one or more alarms | v1 v2 v3 v4
PUT Clears Alarms PUT op/alarms/clear | Clears one or more alarms | v1 v2 v3 v4
PUT Clears Alarms with provided event type PUT op/alarms/clearByEventType | Clears all alarms with provided event type | v1 v2 v3 v4
PUT Clears Alarms with provided port and device IP PUT op/alarms/ClearAlarmsByPort | Clears all alarms with provided port number | v1 v2 v3 v4
PUT Unacknowledges Alarms PUT op/alarms/unacknowledge | Unacknowledges one or more alarms | v1 v2 v3 v4

## Application Visibility and Control Service

Provides resources for discovering and controlling applications within the network.

Resource | Description | API Version
--- | --- | ---
GET Predefined and User-defined Applications GET data/Applications | Returns the list of predefined and user-defined applications. | v1 v2 v3 v4

## 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
--- | --- | ---
GET BNG IP Pool Available Metrics GET op/statisticsService/bngIp/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/bngIp/metrics?deviceName=ME-1200-1& ifName=GigabitEthernet 1/3.ECE.40&evcId=1&tableName=EVC | v1 v2 v3 v4
GET BNG IP Pool Details GET op/statisticsService/bngIp | 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 | v1 v2 v3 v4
GET BNG IP Pool Metric Data GET op/statisticsService/bngIp/metrics/{metric} | 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 | v1 v2 v3 v4

## 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
--- | --- | ---
GET BNG Sessions Available Metrics GET op/statisticsService/bngSessions/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/bngSessions/metrics?device=10.56.23.51&pointType=physical &sessionType=all | v1 v2 v3 v4
GET BNG Sessions Details GET op/statisticsService/bngSessions | 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 | v1 v2 v3 v4
GET BNG Sessions Metric Data GET op/statisticsService/bngSessions/metrics/{metric} | 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 | v1 v2 v3 v4

## 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
--- | --- | ---
GET CEM Available Metrics GET op/statisticsService/cem/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 | v1 v2 v3 v4
GET CEM Details GET op/statisticsService/cem | 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 | v1 v2 v3 v4
GET CEM Metric Data GET op/statisticsService/cem/metrics/{metric} | 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 | v1 v2 v3 v4

## CLI Template Configuration

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

Resource | Description | API Version
--- | --- | ---
GET CLI Configuration Templates GET data/CliTemplate | CLI configuration templates. | v1 v2 v3 v4
DELETE Delete Configuration Template DELETE op/cliTemplateConfiguration/deleteTemplate | Deletes a template from the system. | v1 v2 v3 v4
DELETE Delete Configuration Template Folder DELETE op/cliTemplateConfiguration/folder | Delete folder | v1 v2 v3 v4
GET Download Configuration Template GET op/cliTemplateConfiguration/download | Deprecated Please use the CLI Configuration Templates resource instead. This operation may be removed in a future release. Export a template from the system. | v1 v2 v3 v4
GET List Configuration Template Folders GET op/cliTemplateConfiguration/folder | Get folders | v1 v2 v3 v4
GET List Configuration Templates GET op/cliTemplateConfiguration/templates | Deprecated This operation does not support pagination, filtering, or sorting. Please use the CLI Configuration Templates resource instead. This operation may be removed in a future release. Get a list of the published Templates | v1 v2 v3 v4
GET List Device Types GET op/cliTemplateConfiguration/deviceTypes | Returns the list of device types you can specify for a CLI template. | v1 v2 v3 v4
POST Create Configuration Template Folder POST op/cliTemplateConfiguration/folder | Create new folder | v1 v2 v3 v4
POST Upload Configuration Template POST op/cliTemplateConfiguration/upload | Upload a new template (Troubleshooting template, System template ...) into the system. Does not support Converged Access Templates (IOS-XE templates and templates created from them). | v1 v2 v3 v4
PUT Deploy Configuration Template PUT op/cliTemplateConfiguration/deploy | Deprecated This resource deploys templates in a synchronized way which may take a long time to respond. Use the resource Deploy Configuration Template Through Job instead Deploy a template to a list of devices. Does not support ports selection for the 'Ports' type templates. Does not uptick deploy count. | v1 v2 v3 v4
PUT Deploy Configuration Template Through Job PUT op/cliTemplateConfiguration/deployTemplateThroughJob | Deploy a template to a list of devices through Job. A job name will be returned. Use the parameter startTime to define when the CLI template will be deployed. If the start time is not defined the deployment will start immediately. The start time should be provided in the ISO 8601 format. For example: v1/op/cliTemplateConfiguration/deployTemplateThroughJob?startTime="2016-11-9T07:00Z" Use the job name to query the job result using Job Operations services. To query job status, use the query api/v1/data/JobSummary?jobName=CliTemplateDeploy123. To query the full run result if the deployment fails, use the query api/v1/op/jobService/runhistory?jobName=CliTemplateDeploy123 Does not support ports selection for the 'Ports' type templates. | v1 v2 v3 v4
PUT Modify Configuration Template Content PUT op/cliTemplateConfiguration/template | Update template. Does not support Converged Access Templates (IOS-XE templates and templates created from them). | v1 v2 v3 v4

## 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
--- | --- | ---
GET Circuit Available Metrics GET op/statisticsService/circuits/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 | v1 v2 v3 v4
GET Circuit Details GET op/statisticsService/circuits | 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 | v1 v2 v3 v4
GET Circuit Links Metrics URLs GET op/statisticsService/circuits/links | 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 | v1 v2 v3 v4
GET Circuit Metric Data GET op/statisticsService/circuits/metrics/{metric} | Fetches performance data of a given circuit and counter name. Example: /op/statisticsService/circuits/metrics/Ipslay1731AvgAvailability?maxResults=24&timeInterval=6&circuitType=EVC&circuitId=16229216 | v1 v2 v3 v4

## Clients

Provides information about wired and wireless clients.

Resource | Description | API Version
--- | --- | ---
GET Client Counts GET data/ClientCounts | Represents number of clients counted during the last polling cycle. The combination of type, key and subtype represents number of clients associated with the entity. | v1 v2 v3 v4
GET Client Details GET data/ClientDetails | Represents the detail view of a client. It provides attributes of client device, security information, connected device, traffic and session information. All information is collected in current or last session. | v1 v2 v3 v4
GET Client Sessions GET data/ClientSessions | Represents detail view of client sessions. It provides device and session related attributes including security, connected device, session time, traffic, etc. | v1 v2 v3 v4
GET Client Summary GET data/Clients | Represents client view with information about the end points. It provides end point information such as MAC address, IP address, username, and status. | v1 v2 v3 v4
GET Client Traffic Information GET data/ClientTraffics | Represents clients traffic information collected during the last polling cycle. | v1 v2 v3 v4
GET Historical Client Counts GET data/HistoricalClientCounts | Represents client count collected in last 24 hours with 5 minutes (default) interval. The dataset could be really big. When querying, you must use paged query or filtered by entity or time. Otherwise it could result in longer running query to affect system performance. | v1 v2 v3 v4
GET Historical Client Traffic Information GET data/HistoricalClientTraffics | Represents client traffic information collected in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying, you must use paged query or filtered by entity or time. Otherwise it could be resulted in longer running query to affect system performance. | v1 v2 v3 v4

## Configuration Archive Service

Provides services for configuration file, diff and versions operations.

Resource | Description | API Version
--- | --- | ---
GET Bulk export sanitized configuration archives GET data/BulkSanitizedConfigArchives | Intended to bulk export of sanitized configuration files from archive. This API resource does not support filtering and sorting on configuration files content. | v1 v2 v3 v4
GET Bulk export unsanitized configuration archives GET data/BulkUnsanitizedConfigArchives | Intended to bulk export of unsanitized configuration files from archive. This API resource does not support filtering and sorting on configuration files content. | v1 v2 v3 v4
GET Configuration archive list GET data/ConfigArchives | Configuration archive for device | v1 v2 v3 v4
GET Configuration versions and files list GET data/ConfigVersions | Represents information about the version of the configuration files | v1 v2 v3 v4
GET All MNEs GET op/configArchive/ViewService/getAllMNEs | This operation will return the all MNEs. | v1 v2 v3 v4
GET Config Archive Summary GET op/configArchive/ViewService/getConfigArchiveSummary/{groupId} | This operation will perform the config archive summary. | v1 v2 v3 v4
GET Config File By VesrionId GET op/configArchive/ViewService/getConfigFilesByVersionId/{versionId}/{versionDeviceId}/{popUp} | This operation can be used to get the config file list for the specified version id. | v1 v2 v3 v4
GET Config Header GET op/configArchive/ViewService/getConfigHeader/{configFileId} | This operation can be used to get the config header. | v1 v2 v3 v4
GET Configuration Diff GET op/configArchiveService/configDiff/{device} | Compute Running Configuration Diff. Currently supported only for router devices. | v1 v2 v3 v4
GET Delete Config Version GET op/configArchive/ViewService/deleteConfigVersion/{verisonId} | Delete the config version. | v1 v2 v3 v4
GET Detailed Job Results GET op/configArchive/ViewService/getDetailedResults/{jobId}/{deviceId} | This operation can be used to get detailed config deploy job results by using job id and device id. | v1 v2 v3 v4
GET Diff GET op/configArchive/ViewService/getDiff/{sourceFileId}/{destinationFileId}/{isProcessed}/ | This operation can be used to get the diff by using source file id, destination file id and isprocessed. | v1 v2 v3 v4
GET Difference GET op/configArchive/ViewService/getDifference/{sourceFileId}/{destinationFileId}/{isProcessed}/{iSConfigTypeCheckRequired}/ | This operation can be used to get the config diff between startup and running. | v1 v2 v3 v4
GET Download the sanitized configuration file GET op/configArchiveService/extractSanitizedFile | Extract a sanitized configuration file (not applicable for config files with type VLAN and DATABASE) | v1 v2 v3 v4
GET Download the unsanitized configuration file GET op/configArchiveService/extractUnsanitizedFile | Extract an unsanitized configuration file (not applicable for config files with type VLAN and DATABASE) | v1 v2 v3 v4
GET Export Config By FileId GET op/configArchive/ViewService/exportConfigFileById/{fileId} | Export config by using fileId. | v1 v2 v3 v4
GET Export Config By Id GET op/configArchive/ViewService/exportConfigById/{fileId}/{isMaskRequired} | Export config by using fileId,isMaskRequired. | v1 v2 v3 v4
GET JobResults GET op/configArchive/ViewService/getJobResults/{jobId} | This operation can be used to get the config archive job details. | v1 v2 v3 v4
GET Missmatch Info GET op/configArchive/ViewService/getMismatchInfo | This operation can be used to get config miss match info. | v1 v2 v3 v4
GET Previous Diff GET op/configArchive/ViewService/getPreviousDiff/{sourceFileId}/{isProcessed} | This operation can be used to compare previous diff. | v1 v2 v3 v4
GET Processed Config GET op/configArchive/ViewService/getProcessedConfig/{configFileId} | This operation can be used to get the processed config by using config file id. | v1 v2 v3 v4
GET Raw Config By FileId GET op/configArchive/ViewService/getRawConfigByFileId/{fileId} | This operation can be used to get the raw config. | v1 v2 v3 v4
GET Tags GET op/configArchive/ViewService/getTags | This operation can be used to get the tags. | v1 v2 v3 v4
POST Database Config Supported Devices POST op/configArchive/ViewService/getDatabaseConfigSupportedDevices | This operation can be used to get the database config supported devices. | v1 v2 v3 v4
POST Export Config Version As Zip POST op/configArchive/ViewService/ExportConfigVersionAsZip/{allConfig}/{sanitized} | Export config as ZIP. | v1 v2 v3 v4
POST Schedule Archive POST op/configArchive/ViewService/scheduleArchive | This operation can be used to schedule configuration archive collection. | v1 v2 v3 v4
POST Schedule Deploy POST op/configArchive/ViewService/scheduleDeploy | This operation can be used to deploy config on device. | v1 v2 v3 v4
POST Schedule Rollback POST op/configArchive/ViewService/scheduleRollback | This operation will perform the rollback operation on device. | v1 v2 v3 v4
POST Schedule Sync POST op/configArchive/ViewService/scheduleSync | This operation can be used to get schedule config sync. | v1 v2 v3 v4

## Device Details

The Device Details category provides basic information about the managed devices:

- Device summary and inventory information about devices.
- Events and alarms in the system.

Resource | Description | API Version
--- | --- | ---
GET Alarms GET data/Alarms | Alarm is a representation of the fault or change of state that occurred in the managed system; it could be resource or service and customer related. Alarms are associated with a group of events received from the managed resources, usually with the same source and category, indicating that such fault or event had occurred. | v1 v2 v3 v4
GET Devices GET data/Devices | Represents the device view with information about the managed network elements. It provides device information such as device name, device type, ip address, software type, version, and also provides the reachability and management status. | v1 v2 v3 v4
GET Events GET data/Events | Represents a "normalized" record of an occurrence reported by the network (or any system capable of notifying of such an occurrence); it could be a syslog, SNMP trap, or any other such type. The term "normalized" denotes a single format abstracted over all types of reported events, regardless of source and structure. | v1 v2 v3 v4
GET Inventory Details GET data/InventoryDetails | It provides an aggregated view of all the available inventory information for the device. | v1 v2 v3 v4
GET Meraki Access Points GET data/MerakiAccessPoints | Represents basic information about Meraki access points. | v1 v2 v3 v4
GET Meraki Devices GET data/MerakiDevices | Represents basic information about Meraki devices. The API resource does not include Meraki access points or Meraki dashboard devices. | v1 v2 v3 v4
GET RogueApAlarms GET data/RogueApAlarms | Represents Rogue Access Point Alarms. It includes basic alarm attributes and additional details for Rogue AP alarms. Alarm is a representation of the fault or change of state that occurred in the managed system; it could be resource or service and customer related. Alarms are associated with a group of events received from the managed resources, usually with the same source and category, indicating that such fault or event had occurred. | v1 v2 v3 v4
GET RogueApDetectionHistory GET data/RogueApDetectionHistory | Represents Rogue AP detection history data. Use alarmId or rogueMacAddress attribute to filter detection history for a certain Rogue AP. | v1 v2 v3 v4
GET Syslogs GET data/Syslogs | Represents the syslog view. Syslogs are standard method for logging messages such as system events in an IP network. This API only supports Syslogs with severities 0, 1, 2 (Emergency, Alert, Critical) | v1 v2 v3 v4

## 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
--- | --- | ---
POST Delete devices through job POST op/devices/removalJob | Delete one or more devices through a batch job. | v1 v2 v3 v4
POST Synchronize devices POST op/devices/syncDevices | Synchronize devices. Forces an inventory collection of the specified devices. The API accepts the hostname, the IP address, or the management address of the device. | v1 v2 v3 v4
PUT Bulk Import PUT op/devices/bulkImport | An operation to add or update multiple devices using a batch job. For Json payload, Content-Type should be provided in HTTP header with value "application/json". Example: Content-Type=application/json Credential Profiles Support There are limitations on importing devices with a credential profile. If credentialProfileName parameter is specified and is not empty, this device should not contain any other credential parameters. Parameters allowed to be used with credentialProfileName are: ipAddress, networkMask, and udfs. If other credential parameters are set along with credentialProfileName they will be ignored. User Defined Field Support This service supports importing and exporting devices with User Defined Fields (UDF). The maximum length of a UDF value is 255 characters; devices which have UDF values greater than 255 characters will be ignored. Each bulk Import service request overwrites existing UDF records. To update the UDF of a device, follow the steps: Retrieve the full list UDFs of the device using the GET op/devices/exportDevices resource. Find the UDF entry to be updated in the list. Assign the new value of the entry. Use this resource to save the change. Civic Property Support Civic properties country, region, county, state, city, street, building, room, floor, latitude, longitude and altitude are supported. For attribute Country, the equivalent value is represented below. Example: To set Country as "Afghanistan", use the value as "AFG". "Afghanistan":"AFG", "Albania":"ALB", "Algeria":"DZA", "American Samoa":"ASM", "Andorra":"AND", Angola":"AGO", "Anguilla":"AIA", "Antarctica":"ATA", "Antigua and Barbuda":"ATG", "Argentina":"ARG", "Armenia":"ARM", "Aruba":"ABW", "Australia":"AUS", "Austria":"AUT", "Azerbaijan":"AZE", "Bahamas":"BHS", "Bahrain":"BHR", "Bangladesh":"BGD", "Barbados":"BRB", "Belarus":"BLR", "Belgium":"BEL", "Belize":"BLZ", "Benin":"BEN", "Bermuda":"BMU","Bhutan":"BTN", "Bolivia":"BOL", "Bosnia and Herzegovina":"BIH", "Botswana":"BWA", "Brazil":"BRA" , "British Indian Ocean Territory":"IOT", "British Virgin Islands":"VGB","Brunei":"BRN","Bulgaria":"BGR", "Burkina Faso":"BFA", "Burundi":"BDI", "Cambodia":"KHM", "Cameroon":"CMR", "Canada":"CAN", "Cape Verde":"CPV", "Cayman Islands":"CYM", "Central African Republic":"CAF", "Chad":"TCD", "Chile":"CHL", "China":"CHN", "Christmas Island":"CXR", "Cocos Islands":"CCK", "Colombia":"COL", "Comoros":"COM", "Cook Islands":"COK", "Costa Rica":"CRI", "Croatia":"HRV", "Cuba":"CUB", "Curacao":"CUW", "Cyprus":"CYP", "CzechRepublic":"CZE", "Democratic Republic of the Congo":"COD", "Denmark":"DNK", "Djibouti":"DJI", "Dominica":"DMA", "Dominican Republic":"DOM", "East Timor":"TLS", "Ecuador":"ECU", "Egypt":"EGY", "El Salvador":"SLV","Equatorial Guinea":"GNQ", "Eritrea":"ERI", "Estonia":"EST", "Ethiopia":"ETH", "Falkland Islands":"FLK", "Faroe Islands":"FRO", "Fiji":"FJI", "Finland":"FIN", "France":"FRA", "French Polynesia":"PYF", "Gabon":"GAB", "Gambia":"GMB", "Georgia":"GEO", "Germany":"DEU", "Ghana":"GHA", "Gibraltar":"GIB", "Greece":"GRC", "Greenland":"GRL", "Grenada":"GRD", "Guam":"GUM", "Guatemala":"GTM" , "Guernsey":"GGY", "Guinea":"GIN","Guinea-Bissau":"GNB", "Guyana":"GUY", "Haiti":"HTI", "Honduras":"HND", "Hong Kong":"HKG", "Hungary":"HUN", "Iceland":"ISL", "India":"IND", "Indonesia":"IDN", "Iran":"IRN", "Iraq":"IRQ", "Ireland":"IRL" , "Isle ofMan":"IMN", "Israel":"ISR", "Italy":"ITA", "Ivory Coast":"CIV", "Jamaica":"JAM", "Japan":"JPN", "Jersey":"JEY", "Jordan":"JOR", "Kazakhstan":"KAZ", "Kenya":"KEN", "Kiribati":"KIR", "Kosovo":"XKX", "Kuwait":"KWT", "Kyrgyzstan":"KGZ" , "Laos":"LAO", "Latvia":"LVA", "Lebanon":"LBN", "Lesotho":"LSO", "Liberia":"LBR", "Libya":"LBY", "Liechtenstein":"LIE", "Lithuania":"LTU" , "Luxembourg":"LUX", "Macao":"MAC", "Macedonia":"MKD","Madagascar":"MDG" , "Malawi":"MWI", "Malaysia":"MYS", "Maldives":"MDV", "Mali":"MLI" , "Malta":"MLT", "Marshall Islands":"MHL", "Mauritania":"MRT", "Mauritius":"MUS", "Mayotte":"MYT" , "Mexico":"MEX","Micronesia":"FSM", "Moldova":"MDA", "Monaco":"MCO" , "Mongolia":"MNG", "Montenegro":"MNE", "Montserrat":"MSR", "Morocco":"MAR", "Mozambique":"MOZ" , "Myanmar":"MMR", "Namibia":"NAM", "Nauru":"NRU", "Nepal":"NPL","Netherlands":"NLD" , "Netherlands Antilles":"ANT" , "New Caledonia":"NCL", "New Zealand":"NZL", "Nicaragua":"NIC" , "Niger":"NER", "Nigeria":"NGA", "Niue":"NIU", "North Korea":"PRK", "Northern MarianaIslands":"MNP", "Norway":"NOR", "Oman":"OMN", "Pakistan":"PAK" , "Palau":"PLW", "Palestine":"PSE", "Panama":"PAN", "Papua New Guinea":"PNG", "Paraguay":"PRY", "Peru":"PER", "Philippines":"PHL", "Pitcairn":"PCN" ,"Poland":"POL", "Portugal":"PRT", "Puerto Rico":"PRI", "Qatar":"QAT", "Reunion":"REU", "Romania":"ROU", "Russia":"RUS", "Rwanda":"RWA", "Saint Barthelemy":"BLM", "Saint Helena":"SHN" , "Saint Kitts and Nevis":"KNA", "SaintLucia":"LCA", "Saint Martin":"MAF", "Saint Pierre and Miquelon":"SPM", "Saint Vincent and the Grenadines":"VCT", "Samoa":"WSM", "San Marino":"SMR", "Sao Tome and Principe":"STP", "Saudi Arabia":"SAU", "Senegal":"SEN","Serbia":"SRB", "Seychelles":"SYC", "Sierra Leone":"SLE", "Singapore":"SGP", "Sint Maarten":"SXM", "Slovenia":"SVN", "Solomon Islands":"SLB", "Somalia":"SOM" , "South Africa":"ZAF", "South Korea":"KOR", "SouthSudan":"SSD", "Spain":"ESP", "Sri Lanka":"LKA", "Sudan":"SDN" , "Suriname":"SUR", "Svalbard and Jan Mayen":"SJM", "Swaziland":"SWZ", "Sweden":"SWE" , "Switzerland":"CHE","Syria":"SYR", "Taiwan":"TWN", "Tajikistan":"TJK", "Tanzania":"TZA", "Thailand":"THA", "Togo":"TGO", "Tokelau":"TKL", "Tonga":"TON", "Trinidad and Tobago":"TTO", "Tunisia":"TUN", "Turkey":"TUR","Turkmenistan":"TKM", "Turks and Caicos Islands":"TCA", "Tuvalu":"TUV", "U.S. Virgin Islands":"VIR", "Uganda":"UGA", "Ukraine":"UKR" , "United Arab Emirates":"ARE", "United Kingdom":"GBR", "United States":"USA", "Uruguay":"URY", "Uzbekistan":"UZB", "Vanuatu":"VUT", "Vatican":"VAT", "Venezuela":"VEN", "Vietnam":"VNM", "Wallis and Futuna":"WLF" , "Western Sahara":"ESH", "Yemen":"YEM", "Zambia":"ZMB", and "Zimbabwe":"ZWE". For attribute region, the possible values are represented below. Example: To set region as "Africa", use the value as "Africa". "Africa", "Asia Pacific", "Europe", "Latin America", "Middle East", and "North America". TL1 Credentials Support Transaction Language 1 (TL1) credentials are not currently supported for this operation. | v1 v2 v3 v4
PUT Delete Devices PUT op/devices/deleteDevices | Deprecated This operation deletes devices in a synchronized way which may take a long time to respond. Use the Delete devices through job resource instead An operation to delete devices by ip address. The response time of this service varies and depends on the status of the devices. The API accepts the hostname, the IP address, or the management address of the device to be deleted. Firstly, the API tries to find the device by its management address. Then, if it has not been found, the API tries to find it by IP address and hostname. If there are more than one device with the same IP address or hostname an error will be returned. In this case you should use management address to delete the device. | v1 v2 v3 v4
PUT DeviceBulkImportWithCsv PUT op/devices/bulkImportWithCsv | An operation to add or update multiple devices using csv file and batch job. The functionality is same as devices/bulkImport and here the input payload is csv file which contains the device information (ip_address, licenceLevel, snmp_version, snmp_community, snmp_write_community, snmp_retries, snmp_timeout, snmp_port, protocol, cli_portcli_username, cli_password, cli_enable_password, cli_sshKeyAndAlgo, cli_timeout,snmpv3_user_name, snmpv3_auth_type, snmpv3_auth_password, snmpv3_privacy_type, snmpv3_privacy_password, http_server, http_port, http_config_username, http_config_password, http_monitor_username, http_monitor_password, udf:PRODUCT_NAME, udf:PRODUCT_ID, ipsec_mode, ipsec_ike_version, ipsec_others, tl1_username, tl1_password, tl1_primary_proxy_address, tl1_secondary_proxy_address, tl1_transport, tl1_single_ems_session, location_groupname, user_groupname, region, country, state, city, county, street, building, floor, room, longitude, latitude, altitude, assigned_network_role). It supports civic properties and User Defined Fields as well. The output of the operation is job name and the new job will be created for every 2000 devices. | v1 v2 v3 v4
PUT Schedule AP Maintenance Mode PUT op/configure/ap/scheduleMaintenanceMode | Creates a job to set maintenance mode for unified access points. For other device types should use PUT Schedule Maintenance Mode. Maintenance mode status for a unified AP can be retrieved with the response parameter "unifiedApInfo.maintenanceMode" from the API GET Wireless Access Point Details. | v1 v2 v3 v4
PUT Schedule Maintenance Mode PUT op/configure/device/scheduleMaintenanceMode | Creates a job to set maintenance mode. This resource is intended for use with routers, switches, wireless controllers, autonomous access points, and other types of devices except for unified access points. To get the current management status and the maintenance mode reason for a device, see the "managementStatus" and "collectionDetail" response parameters from Devices. | v1 v2 v3 v4
PUT Set AP Maintenance Mode PUT op/configure/ap/maintenanceMode | Sets the maintenance mode for unified access points. For other device types should use PUT Set Device Maintenance Mode. Maintenance mode status for a unified AP can be retrieved with the response parameter "unifiedApInfo.maintenanceMode" from the API GET Wireless Access Point Details. | v1 v2 v3 v4
PUT Set Device Maintenance Mode PUT op/configure/device/maintenanceMode | Sets the device maintenance mode. This resource is intended for use with routers, switches, wireless controllers, autonomous access points, and other types of devices except for unified access points. For unified access points, please use PUT Set AP Maintenance Mode. To get the current management status and the maintenance mode reason for a device, see the "managementStatus" and "collectionDetail" response parameters from Devices. | v1 v2 v3 v4

## 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
--- | --- | ---
GET Device Sensors Available Metrics GET op/statisticsService/sensors/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 | v1 v2 v3 v4
GET Device Sensors Details GET op/statisticsService/sensors | 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 | v1 v2 v3 v4
GET Device Sensors Metric Data GET op/statisticsService/sensors/metrics/{metric} | 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 | v1 v2 v3 v4

## GNSS Statistics

The GNSS (Global Navigation Satellite System) Statistics API displays different GNSS module 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 - "GNSS Details". The response will contain the exact URL for the next method ("GNSS Available Metrics").

- GNSS Details
- GNSS Available Metrics
- GNSS Performance Data

Resource | Description | API Version
--- | --- | ---
GET GNSS Available Metrics GET op/statisticsService/gnss/metrics | Fetches all metrics that are collected for a specific GNSS module, as well as the URL of the next step ("GNSS Performance Data") that is available under the "url" element. Available metrics are: GNSS Module Lock Status, GNSS Module Satellite Count and GNSS Satellite Visibility Status Example: op/statisticsService/gnss/metrics?device=10.56.23.109 | v1 v2 v3 v4
GET GNSS Details GET op/statisticsService/gnss | Fetches the GNSS module details per device. In addition to the URL for the next step that is available under the "metricsLink" element. Example: op/statisticsService/gnss Example: op/statisticsService/gnss?device=10.56.23.10 | v1 v2 v3 v4
GET GNSS performance Data GET op/statisticsService/gnss/metrics/{metric} | Fetches performance measurements of a given metric for a specific GNSS module over a given period. Example: op/statisticsService/gnss/metrics/?timeInterval=6&metricDataType=TIME_SERIES &device=10.56.23.109 | v1 v2 v3 v4

## Group Management Service

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

Resource | Description | API Version
--- | --- | ---
DELETE Delete device or port group DELETE op/groups/group | Delete a device or port group by it's ID or full path and name. Only Location and User Defined Device groups and User Defined port groups are supported. | v1 v2 v3 v4
GET Device Group Rules GET op/groups/groupRules | Get list of group rules. Only Location and Network Device groups are supported. | v1 v2 v3 v4
PUT Assign devices to a group PUT op/groups/groupDevices | Statically assign list of devices to a group (devices are listed by device IDs or IP addresses). Only Location and User Defined device groups are supported. | v1 v2 v3 v4
PUT Create or update device or port group PUT op/groups/group | Create or update a device or port group. Only Location and User Defined Device groups and User Defined port groups are supported. You cannot modify the system defined groups except 'Location/All Locations/System Campus' for which you can change only description and geographical location. | v1 v2 v3 v4
PUT Remove devices from a group PUT op/groups/removeDevices | Remove list of devices from a group (devices are listed by device IDs or IPs). Only Location and User Defined Device groups are supported. | v1 v2 v3 v4
PUT Replace set of group rules PUT op/groups/groupRules | Replace set of group rules with a new one. Only Location and Network Device groups are supported. | v1 v2 v3 v4

## Group Summary Service

The Group Summary Service provides a summary of alarms per group for each type of group (Site, Device Type or User Defined Group) , an overall alarm summary and a summary of the number devices per Site.

Resource | Description | API Version
--- | --- | ---
GET Device Groups GET data/DeviceGroups | Deprecated Do not use this resource. Replaced by API Device Groups. 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". | v1 v2 v3 v4
GET Group Specification GET data/GroupSpecification | Provides a view of group specific information of devices. Use this service to query or navigate groups | v1 v2 v3 v4
GET Sites GET data/Sites | Deprecated Do not use this resource. Replaced by API Location Groups. 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". | v1 v2 v3 v4
GET User Defined Groups GET data/UserDefinedGroups | Deprecated Do not use this resource. Replaced by API User Defined Groups. 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". | v1 v2 v3 v4
GET Alarm Summary GET op/groups/alarmSummary | Provides alarm summary information including: total number of alarms, number of alarmed devices, number of alarmed sites, number of alarmed APs and number of clients associated with the alarmed APs. Does not count cleared alarms. | v1 v2 v3 v4
GET Device Groups GET op/groups/deviceGroups | Returns list of Device Type groups, including the count of alarms of each severity for each group. Note that the API can be slow when you have large amount of groups, alarms, and devices. Use noAlarms and noMembersCount parameters to improve the performance of this API resource. | v1 v2 v3 v4
GET Location Groups GET op/groups/sites | Returns list of Locations, including the count of alarms of each severity for each group. Also includes counts of devices, APs and Clients associated with the Location and also location information regarding the location. This service was formerly known as "Site Groups." This operation returns groups explicitly or implicitly assigned to your active virtual domain. Explicit groups have been created or later added to your active virtual domain (or were a child group of a group added to your active virtual domain). Implicit groups are groups with a close relation to an explicit group, for example, parents of explicit groups. | v1 v2 v3 v4
GET User Defined Groups GET op/groups/userDefinedGroups | Returns list of User Defined groups for both Network Device Groups and Port Groups, including the count of alarms of each severity for each group. This operation returns groups explicitly or implicitly assigned to your active virtual domain. Explicit groups have been created or later added to your active virtual domain (or were a child group of a group added to your active virtual domain). Implicit groups are groups with a close relation to an explicit group, for example, parents of explicit groups. Note that Port Groups do not support virtual domain based filtering. You will be allowed to modify a Port group, even if it is implicitly assigned to your active virtual domain. | v1 v2 v3 v4

## Guest User Management Service

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

Resource | Description | API Version
--- | --- | ---
GET Get guest users GET data/GuestUsers | Returns a list of guest users. | v1 v2 v3 v4
GET Get guest users from controller GET op/guestUser/guestUsersOnController | Lists guest user names currently associated with a particular controller. | v1 v2 v3 v4
GET Get logged in guest users from controller GET op/guestUser/loggedInGuestUsersOnController | Lists guest user names currently logged in and associated to a particular controller. | v1 v2 v3 v4
POST Create guest user POST op/guestUser | Creates a new guest user. | v1 v2 v3 v4
POST Schedule guest user POST op/guestUser/schedule | Schedule a guest user. | v1 v2 v3 v4
PUT Delete guest user PUT op/guestUser/delete | Deletes a guest user. | v1 v2 v3 v4
PUT Reschedule guest user PUT op/guestUser/schedule | Reschedule an existing guest user. User name is used to identify the guest user to be edited. | v1 v2 v3 v4
PUT Update guest user PUT op/guestUser | Updates an existing guest user. User name is used to identify the guest user to be edited. | v1 v2 v3 v4

## 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
--- | --- | ---
GET IPSLA (ICMP JITTER) Available Probe Metrics GET op/statisticsService/ipsla/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 | v1 v2 v3 v4
GET IPSLA (ICMP JITTER) Probe Details GET op/statisticsService/ipsla | 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 | v1 v2 v3 v4
GET IPSLA (ICMP JITTER) Probe Metric Data GET op/statisticsService/ipsla/metrics/{metric} | 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 | v1 v2 v3 v4

## 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
--- | --- | ---
GET IPSLA Y1731 Available Probe Metrics GET op/statisticsService/y1731/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 | v1 v2 v3 v4
GET IPSLA Y1731 Probe Details GET op/statisticsService/y1731 | 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 | v1 v2 v3 v4
GET IPSLA Y1731 Probe Metric Data GET op/statisticsService/y1731/metrics/{metric} | 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 | v1 v2 v3 v4

## 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
--- | --- | ---
GET Interface CRC Errors Available Metrics GET op/statisticsService/interfacecrc/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 | v1 v2 v3 v4
GET Interface CRC Errors Details GET op/statisticsService/interfacecrc | 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 | v1 v2 v3 v4
GET Interface CRC Errors Metric Data GET op/statisticsService/interfacecrc/metrics/{metric} | Fetches performance data of a given metric or metrics for a specific interface over a given period. Examples: op/statisticsService/interfacecrc/metrics/crcErrorsRate?startTime=1499153553628& endTime=1499157153628&metricDataType=TIME_SERIES&device=10.56.23.63& ifName=BDI519 op/statisticsService/interfacecrc/metrics/stats?metrics=crcErrorsRate& 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 op/statisticsService/interfacecrc/metrics/crcErrorsRate?startTime=1499153553628& endTime=1499157153628&metricDataType=TOP_N | v1 v2 v3 v4

## Job Operations

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

Resource | Description | API Version
--- | --- | ---
GET Job Summary GET data/JobSummary | Provides a consolidated view of the latest status of all scheduled jobs. Use this resource to get a quick job status check. To query system jobs , specify username=SYSTEM | v1 v2 v3 v4
GET Query Job Run History GET op/jobService/runhistory | Query the past run instances of a job. All request parameters are optional. If no parameters are specified, If no parameters are specified, no run instances will be returned.. NBI filtering can be applied to the parameters to customize the query. Please refer the filtering page for the details of how to use filtering Examples : get the run history of the job 123 --/jobService/runhistory?jobId=123 get the run history of job 123 and job 456 between 2013-04-26T14:00:00 and 2013-04-26T16:00:00 -- /jobService/runhistory?jobId=in(123,456)&startTime=between("2013-04-26T14:00:00","2013-04-26T16:00:00") get all run history of jobs with job name starting with "BulkImport" -- jobService/runhistory?jobName=startsWith("BulkImport") | v1 v2 v3 v4
PUT Cancel A Job PUT op/jobService/cancel | Disable the trigger permanently. The canceled job cannnot be resumed using "Resume A Job" service | v1 v2 v3 v4
PUT Cancel A Job running instance PUT op/jobService/cancelrunning | Stop a running instance of a job. | v1 v2 v3 v4
PUT Resume A Job PUT op/jobService/resume | Re-enable the trigger of a suspended job. | v1 v2 v3 v4
PUT Suspend A Job PUT op/jobService/suspend | Disable the trigger temporarily. The job will no longer run when suspended. To re-enable the job trigger, use 'Resume A Job' service. Suspending a job in running status dose not impact the running instance. | v1 v2 v3 v4

## Link Statistics

The Link Statistics provides performance data of links. Using a step-by-step process, by providing only the link id, user can retrieve performance data for each of the counters available depending on the link 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 - Link Details. The response will already contain the exact url for the next method (Link Available Metrics). Statistics will be available once appropriate monitoring policy is enabled. The order of the rest calls is as follows:

- Link Details
- Link Available Metrics
- Link Metric Data

Resource | Description | API Version
--- | --- | ---
GET Link Available Metrics GET op/statisticsLink/links/metrics | Fetches all the counters that are relevant for the link type, the counter type, and the url of the next step (link Metric Data) that is available under the "url" element. Example: /op/statisticsLink/links/metrics?linkId=1640554&linkType=PSEUDOWIRE | v1 v2 v3 v4
GET Link Details GET op/statisticsLink/links | Fetches the link basic details, in addition to the url for the next step (Link Available Metrics) that is available under the "metricsLink" element. Example: /op/statisticsLink/links?.full=true&linkId=1640554 | v1 v2 v3 v4
GET Link Metric Data GET op/statisticsLink/links/metrics/{metric} | Fetches performance data of a given link and counter name. Example: /op/statisticsLink/links/metrics/PswdAvailability?linkId=1640554&maxResults=24&timeInterval=6&endpointName=PW_267_8.8.8.8&deviceId=1548600_10.56.23.49 | v1 v2 v3 v4

## MAC Filters Management Service

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

Resource | Description | API Version
--- | --- | ---
GET MAC Filter Templates GET data/MacFilterTemplates | Returns a list of MAC filter templates. | v1 v2 v3 v4
DELETE Delete MAC Filter Template DELETE op/macFilter/macFilterTemplate | Deletes an existing MAC filter template. | v1 v2 v3 v4
POST Create MAC Filter Template POST op/macFilter/macFilterTemplate | Create new MAC filter template. | v1 v2 v3 v4
PUT Deploy MAC Filter Template PUT op/macFilter/deploy | Deploy a MAC filter to WLAN controllers. | v1 v2 v3 v4
PUT Update MAC Filter Template PUT op/macFilter/macFilterTemplate | Updates an existing MAC filter template. Template name is used to identify the template to be edited. | v1 v2 v3 v4

## Manage and Monitor Info Service

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

Resource | Description | API Version
--- | --- | ---
GET Core Dumps GET op/info/coredumps | Returns the number of application core dumps present on the server. | v1 v2 v3 v4
GET Disk Usage and Capacity GET op/info/disk | Returns capacity and usage information for the volumes present on the application's server. | v1 v2 v3 v4
GET Licenses GET op/info/license | Returns license information about the application. | v1 v2 v3 v4
GET Uptime GET op/info/uptime | Returns uptime information as well as information about the application and the server it runs on. | v1 v2 v3 v4
GET Version GET op/info/version | Returns the version of the application. | v1 v2 v3 v4

## Managed Servers Operations

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

Resource | Description | API Version
--- | --- | ---
DELETE Delete managed server DELETE op/managedServers | Supported products: Operations Center Deletes a managed server from Operations Center. | v1 v2 v3 v4
GET Get managed servers information GET op/managedServers | Supported products: Operations Center Provides information about servers managed by Operations Center. | v1 v2 v3 v4
GET Provides information on a managed server mode (active or deactivated) GET op/managedServers/mode | Supported products: Operations Center Provides information on the managed server mode (active or deactivated). | v1 v2 v3 v4
POST Adds a new managed server to Operations Center POST op/managedServers | Supported products: Operations Center Adds a new managed server to Operations Center. | v1 v2 v3 v4
PUT Activate/deactivate managed server PUT op/managedServers/mode | Supported products: Operations Center Deactivates or activates managed server depending on the selected mode. Operations center does not collect data from deactivated servers. | v1 v2 v3 v4
PUT Updates managed server details PUT op/managedServers | Supported products: Operations Center Updates managed server configurations, such as server name, port and alias. If no port is specified, the default value will be used. If no alias is specified, the current alias will be reset. | v1 v2 v3 v4

## 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
--- | --- | ---
GET Me1200 Quality of Service Available Metrics GET op/statisticsService/me1200qos/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 | v1 v2 v3 v4
GET Me1200 Quality of Service Details GET op/statisticsService/me1200qos | 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 | v1 v2 v3 v4
GET Me1200 Quality of Service Metric Data GET op/statisticsService/me1200qos/metrics/{metric} | 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 | v1 v2 v3 v4

## Network Topology Layout

Resource | Description | API Version
--- | --- | ---
GET Get Global Topology Layout GET op/topology/layout/global | retrieves the global topology layout for a given group | v1 v2 v3 v4
POST Save Global Topology Layout POST op/topology/layout/global | saves the global toplogy layout per group | v1 v2 v3 v4

## 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
--- | --- | ---
GET Optical Ethernet Metrics GET op/statisticsService/opticalethernet/metrics | Fetches the URLs for various metrics of an Interface Example: statisticsService/opticalethernet/metrics?device=NCS2006-110& ifName=GigabitEthernet0/6&pmInterval=15-MIN&startTime=1498995120297& endTime=1498998320297 | v1 v2 v3 v4
GET Optical Ethernet Performance Data GET op/statisticsService/opticalethernet/metrics/{metric} | 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=NCS2006-110& pmInterval=1-DAY | v1 v2 v3 v4
GET Optical Ethernet Resources GET op/statisticsService/opticalethernet | Fetches the details of Interfaces Example: op/statisticsService/opticalethernet | v1 v2 v3 v4

## Optical OTN Data Statistics

Resource | Description | API Version
--- | --- | ---
GET Optical OTN Metrics GET op/statisticsService/opticalotn/metrics | Fetches the URLs for various metrics of an Interface Example: statisticsService/opticalotn/metrics?device=NCS2006-110& ifName=GigabitEthernet0/6&pmInterval=15-MIN&startTime=1498995120297& endTime=1498998320297 | v1 v2 v3 v4
GET Optical OTN Performance Data GET op/statisticsService/opticalotn/metrics/{metric} | 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=NCS2006-110& pmInterval=1-DAY | v1 v2 v3 v4
GET Optical OTN Resources GET op/statisticsService/opticalotn | Fetches the details of Interfaces Example: op/statisticsService/opticalotn | v1 v2 v3 v4

## Optical Physical OSNR Statistics

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

Resource | Description | API Version
--- | --- | ---
GET Optical Physical OSNR Performance Data GET op/statisticsService/opticalphysical/all_metrics/{metric} | Fetches the metric data for provided/requested metric(OSNR-MIN/OSNR-AVG/OSNR-MAX). Example: op/statisticsService/opticalphysical/all_metrics/OSNR-MIN Performance data of a given metric for all probes over a given time period. Example: op/statisticsService/opticalphysical/all_metrics/OSNR-MIN?startTime=1609858104869&endTime=1609836504869 | v1 v2 v3 v4

## 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
--- | --- | ---
GET Optical Physical Metrics GET op/statisticsService/opticalphysical/metrics | Fetches the URLs for various metrics of an Interface Example: statisticsService/opticalphysical/metrics?device=NCS2006-110& ifName=GigabitEthernet0/6&pmInterval=15-MIN&startTime=1498995120297& endTime=1498998320297 | v1 v2 v3 v4
GET Optical Physical Performance Data GET op/statisticsService/opticalphysical/metrics/{metric} | 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=NCS2006-110& pmInterval=1-DAY Example: /webacs/api/v2/op/statisticsService/opticalphysical/metrics/{} | v1 v2 v3 v4
GET Optical Physical Resources GET op/statisticsService/opticalphysical | Fetches the details of Interfaces Example: op/statisticsService/opticalphysical | v1 v2 v3 v4

## 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
--- | --- | ---
GET Optical SFP Available Metrics GET op/statisticsService/opticalSfp/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 | v1 v2 v3 v4
GET Optical SFP Details GET op/statisticsService/opticalSfp | 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 | v1 v2 v3 v4
GET Optical SFP Metric Data GET op/statisticsService/opticalSfp/metrics/{metric} | 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 | v1 v2 v3 v4

## Optical Sonet SDH Statistics

Resource | Description | API Version
--- | --- | ---
GET Optical Sonet SDH Metrics GET op/statisticsService/opticalsonetsdh/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=NCS2006-110& pmInterval=1-DAY | v1 v2 v3 v4
GET Optical Sonet SDH Performance Data GET op/statisticsService/opticalsonetsdh/metrics/{metric} | 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=NCS2006-110& pmInterval=1-DAY | v1 v2 v3 v4
GET Optical Sonet SDH Resources GET op/statisticsService/opticalsonetsdh | Fetches the details of Interfaces Example: op/statisticsService/opticalsonetsdh | v1 v2 v3 v4

## 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
--- | --- | ---
GET PTP Clocks Available Metrics GET op/statisticsService/ptp/metrics | Fetches all metrics that are collected for a specific PTP clock, as well as the URL of the next step ("PTP Clock Performance Data") that is available under the "url" element. Available metrics are: PTP Clock class, PTP Servo State,TX/RX packets,TX/RX packet rates and UTC offset Example: op/statisticsService/ptp/metrics?device=10.56.23.109 | v1 v2 v3 v4
GET PTP Clocks Details GET op/statisticsService/ptp | Fetches the PTP clock details per device, and provides the URL for the next step that is available under the "metricsLink" element. Example: op/statisticsService/ptp Example: op/statisticsService/ptp?device=10.56.23.109 | v1 v2 v3 v4
GET PTP Clocks performance Data GET op/statisticsService/ptp/metrics/{metric} | Fetches performance measurements of a given metric for a specific PTP clock over a given period. For some metrics, it will also include the clock's state (OK/Degraded/Failure) Example: op/statisticsService/ptp/metrics/ptpClockClass?timeInterval=6& metricDataType=TIME_SERIES&device=10.56.23.109 | v1 v2 v3 v4

## 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
--- | --- | ---
GET PTP SyncE Settings Details GET op/ptppreference/system/{keys} | Fetch the current setting in EPNM of the PTP and SyncE metrics. Example: op/ptppreference/system/ptpClockClass,synceQualityLevel,ptpServoState,synceUtcOffset | v1 v2 v3 v4
POST PTP Clock Class Threshold POST op/ptppreference/system/clock | Set the ranges in which PTP Clock Class values are classified as OK, Degraded and Failure. Allowed ranges are 0-255, there should not be an overlap between the ranges of OK/Degraded/Failure. Example: op/ptppreference/system/clock Payload example:{"PtpPreferenceFacade_SetPtpClock_In": {"clockThreshold":"[{\"PtpClockClasse\":\"OK\",\"from\":0,\"to\" :100,\"color\":\"Green\"},{\"PtpClockClasse\":\"Degraded\" ,\"from\":101,\"to\":197,\"color\":\"Orange\"},{\"PtpClockClasse\" :\"Failure\",\"from\":198,\"to\":252,\"color\":\"Red\"}]"}} | v1 v2 v3 v4
POST PTP Servo State POST op/ptppreference/system/servo | Set the classification of each PTP Servo State. For each of the 5 possible PTP Servo State (Freerun, Holdover, Acquiring, Frequency locked & Phase Aligned), define if EPNM will report the state as OK, Degraded or Failure. Example: op/ptppreference/system/servo Payload example:{"PtpPreferenceFacade_SetPtpServoState_In": {"state":"{\"Freerun\":\"Failure\",\"Holdover\" :\"Failure\",\"Acquiring\":\"Failure\",\"Frequency Locked\":\"OK\" ,\"Phase Aligned\":\"Failure\"}"}} | v1 v2 v3 v4
POST Set SyncE Quality Level POST op/ptppreference/system/quality | Set which SyncE quality level is regarded by EPNM is OK. SyncE Quality levels which are defined using this API will be regarded by EPNM as OK. Any other Quality level which is not defined in this list will be regarded by EPNM as Degraded. Example: op/ptppreference/system/quality Payload example:{"PtpPreferenceFacade_SetSynceQualityLevel_In": {"qualityLevel":"{\"option1\":\"INV14(19)\",\"option2\":\" INV8(13)\",\"option3\":\"INV5(10)\"}"}} | v1 v2 v3 v4
POST UTC Offset POST op/ptppreference/system/utc | Set the current UTC offset of the network. Any device in which the UTC offset is different than the value set here will be reported by EPNM as UTC Offset Incorrect. Example: op/ptppreference/system/utc Payload example:{"PtpPreferenceFacade_SetUtcOffset_In":{"offset":58}} | v1 v2 v3 v4

## Plug and Play

Provides operations related to Plug And Play

Resource | Description | API Version
--- | --- | ---
DELETE Delete All Profile Instances of a PnP Profile DELETE op/pnp/profile/{profileName}/instance/ | Deletes all the profile instances of the given pnp profile that passed as path param. | v1 v2 v3 v4
DELETE Delete Pnp Profile DELETE op/pnp/profile/{pnpProfileFolder}/{profileName} | Deletes the exisiting Pnp profiles. | v1 v2 v3 v4
DELETE Delete Profile Instance of a PnP Profile DELETE op/pnp/profile/{profileName}/instance/{instanceName} | Deletes the profile instance of the given pnp profile that passed as path param. | v1 v2 v3 v4
POST Create Pnp Profile POST op/pnp/profile/{pnpProfileFolder} | Creates Pnp profiles | v1 v2 v3 v4
POST Create Update PnP Status POST op/pnp/status/{serialNumber} |  | v1 v2 v3 v4
POST Create or Update Profile Instances of a PnP Profile POST op/pnp/profile/{profileName}/instance/ | Takes Profile Name as rest parameter and List of Profile Instances as payload. If Profile Instance with same name and same profile exist, those get updated otherwise new Profile Instance will be created. | v1 v2 v3 v4
PUT Update Pnp Profile PUT op/pnp/profile/{pnpProfileFolder} | Updates the existing pnp profiles | v1 v2 v3 v4

## 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
--- | --- | ---
GET Quality of Service Available Policy Metrics GET op/statisticsService/qos/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 | v1 v2 v3 v4
GET Quality of Service Policy Details GET op/statisticsService/qos | 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 | v1 v2 v3 v4
GET Quality of Service Policy Metric Data GET op/statisticsService/qos/metrics/{metric} | 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 Example: op/statisticsService/qos/metrics/prepolicypcktraw?startTime=1573028609580&endTime=1573032209583& metricDataType=TOP_N&sort=-avgprepolicypcktraw&deviceGroup=test device group op/statisticsService/qos/metrics/prepolicypcktraw?startTime=1573028609580&endTime=1573032209583& metricDataType=TOP_N&sort=-avgprepolicypcktraw&deviceGroup=12434 op/statisticsService/qos/metrics/prepolicypcktraw?startTime=1573028609580&endTime=1573032209583& metricDataType=TOP_N&sort=-avgprepolicypcktraw&portGroup=test port group op/statisticsService/qos/metrics/prepolicypcktraw?startTime=1573028609580&endTime=1573032209583& metricDataType=TOP_N&sort=-avgprepolicypcktraw | v1 v2 v3 v4

## Rate Limits Management Service

Provides services to obtain and update rate limits

Resource | Description | API Version
--- | --- | ---
GET Get Rate Limits GET op/rateService/rateLimits | Return current rate limiter settings. | v1 v2 v3 v4
PUT Update Rate Limits PUT op/rateService/rateLimits | Update rate limiter settings. The updated settings take effect immediately. | v1 v2 v3 v4

## Report Service

The Report service provides operations to discover and run reports. Reports need to be defined in the system prior to access through the API.

Resource | Description | API Version
--- | --- | ---
GET Get Available Report Templates GET op/reportService/templates | This URL is used to get all the saved report templates. It returns an array of information about the available saved report templates. Report templates need to be set up in the GUI to be available here. | v1 v2 v3 v4
GET Get a Report GET op/reportService/getReport | Deprecated This resource does not supported. Please use the Run a ZIP Report or Get a ZIP Report resources. This URL is used to retrieve the report data for a report that was previously generated from an asynchronous call of the reportService/report URL, or returns the latest result from a scheduled report generation. The pageIndex request parameter can be specified to request a particular page. The pageCount response parameter can be used to identify how many total pages the report has. | v1 v2 v3 v4
GET Get a ZIP Report GET op/reportService/getZipReport | This API is used to retrieve the report data for a report that was previously generated from an asynchronous call of the runReports API, or returns the latest result from a report generation. It return the report output as ZIP of one or more CSV/PDF files. It takes one argument, a String reportTitle, which is the name of the saved report template. | v1 v2 v3 v4
GET Run a Report GET op/reportService/report | Deprecated This resource does not support large report data sets. Please use the Run a ZIP Report or Get a Report resources. This URL is used to generate reports from a specific saved report template and return the report output as an XML/JSON response. It takes two arguments: a String reportTitle - a unique title of the saved report template, and a Boolean async indicating if the call is asynchronous when the value is true. It provides the report data in the case of a synchronous call, or just provides a report URL using which the latest report can be retrieved. | v1 v2 v3 v4
GET Run a ZIP Report GET op/reportService/zipReport | This API operation is used to generate reports from a specific saved report template and return the report output as ZIP of one or more CSV files. It takes one argument, a String reportTitle, which is the name of the saved report template. This API features similarly to the export functionality available in the Report Launch Pad. | v1 v2 v3 v4

## Site Map Service

Services to manage Site Maps.

Resource | Description | API Version
--- | --- | ---
GET Get Site Maps GET data/ServiceDomains | Service domain or Wireless Site Map is object which represents sites, buildings, floors and outside areas. | v1 v2 v3 v4
GET Get image of the specified site map GET op/maps/{mapId}/image | Get the image of specified site map. This operation is supported only for floor and outdoor area. | v1 v2 v3 v4
GET Get rogue APs from the specified site map GET op/maps/{mapId}/rogueAps | Returns list of Rogue access points from the specified site map. This operation is supported only for floor and outdoor area. | v1 v2 v3 v4

## Software Image Management Service

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

Resource | Description | API Version
--- | --- | ---
POST Activate Image POST op/swim/image/activate | This operation will perform the install or activation of image on device. Note: Please use only json payload. xml payload is not supported, it is generated from the framework. | v1 v2 v3 v4
POST Commit Image POST op/swim/image/commit | This operation can be used to commit the changes on IOS-XR device. Note: Please use only json payload. xml payload is not supported, it is generated from the framework. | v1 v2 v3 v4
POST Distribute Image POST op/swim/image/distribute | This operation can be used to copy image to cisco devices. Note: Please use only json payload. xml payload is not supported, it is generated from the framework. | v1 v2 v3 v4
POST Import Image POST op/swim/image/collect | This operation can be used to import image to EPNM. Note: Please use only json payload. xml payload is not supported, it is generated from the framework. | v1 v2 v3 v4

## Software Updates

Provides information about Software Updates.

Resource | Description | API Version
--- | --- | ---
GET Information about current platform GET op/update/platformInfo | Retrieves the information about current platform /op/update/platformInfo - return the MDF ID and the version of the underlying platform | v1 v2 v3 v4
GET Information about updates GET op/update/retrieve | Retrieves the information about updates for a given UBF name or state. Here are the sample queries /op/update/retrieve - return the information about all updates /op/update/retrieve?ubfname=prime_insight_call_home_agent-1.0.0.ubf - return the information about update from UBF with specified name /op/update/retrieve?state=INSTALLED - return the information about updates with state = "INSTALLED" /op/update/retrieve?ubfname=prime_insight_call_home_agent-1.0.0.ubf&state=INSTALLED - return the information about update for a given UBF name and state = "INSTALLED" Available states: AVAILABLE AVAILABLE_PENDING_RESTART INSTALLED INSTALLED_PENDING_RESTART ERROR_ON_INSTALL ERROR_ON_ROLLBACK | v1 v2 v3 v4

## Statistics

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

Resource | Description | API Version
--- | --- | ---
GET All Border Routers GET op/pfrMonitoringExt/getAllBorderRouters/{startTime}/{endTime}/{siteName} |  | v1 v2 v3 v4
GET All IMEs GET op/pfrMonitoringExt/getAllIMEs/{srcSite}/{dstSite}/{startTime}/{endTime} |  | v1 v2 v3 v4
GET All RCs GET op/pfrMonitoringExt/getAllRCs/{srcSite}/{dstSite}/{startTime}/{endTime} |  | v1 v2 v3 v4
GET All TCAs GET op/pfrMonitoringExt/getAllTCAs/{srcSite}/{dstSite}/{startTime}/{endTime} |  | v1 v2 v3 v4
GET CPU Utilization Summary GET op/statisticsService/device/cpuUtilSummary | Gets the device CPU Utilization Summary Statistics. | v1 v2 v3 v4
GET CPU Utilization Trend GET op/statisticsService/device/cpuUtilTrend | Gets the device CPU Utilization Trend statistics. | v1 v2 v3 v4
GET Cluster Details GET op/statisticsService/clusters | Deprecated Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices. | v1 v2 v3 v4
GET Cluster Metric Data GET op/statisticsService/clusters/metrics/{metric} | Deprecated Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices. To fetch data for the following metrics 1. CPU Usage 2. Memory Consumed 3. Memory Usage | v1 v2 v3 v4
GET Cluster Metrics Supported GET op/statisticsService/clusters/metrics | Deprecated Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices. To fetch the URLs for the following metrics 1. CPU Usage 2. Memory Consumed 3. Memory Usage | v1 v2 v3 v4
GET DSCP App Usage GET op/pfrMonitoringExt/getDscpAppUsage/{startTime}/{endTime} |  | v1 v2 v3 v4
GET DSCP App Usage For Live Topo GET op/pfrMonitoringExt/getDscpAppUsageForLiveTopo/{startTime}/{endTime}/{srcSiteId}/{dstSiteId} |  | v1 v2 v3 v4
GET DSCP Time Vs Usage Chart GET op/pfrMonitoringExt/getDSCPTimeVsUsageChart/{startTime}/{endTime}/{siteName}/{brIp}/{dscp}/{noOfPoints} | getDSCPTimeVsUsageChart | v1 v2 v3 v4
GET Datacenter Details GET op/statisticsService/datacenters | Deprecated Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices. | v1 v2 v3 v4
GET Datacenter Metric Data GET op/statisticsService/datacenters/metrics/{metric} | Deprecated Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices. No metrics are supported for Datacenter | v1 v2 v3 v4
GET Datacenter Metrics Supported GET op/statisticsService/datacenters/metrics | Deprecated Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices. No metrics are supported for Datacenter | v1 v2 v3 v4
GET Device Availability GET op/statisticsService/device/availability | Retrieves the Device Availability Summary given an IP Address and range value or startTime, endTime pair. | v1 v2 v3 v4
GET Device Availability Message GET op/statisticsService/device/availabilityMessage | Gets the Device Availability Message Statistics. | v1 v2 v3 v4
GET Device Availability Summary GET op/statisticsService/device/availabilitySummary | Retrieves the Device Availability Summary given a range value or startTime, endTime pair, a source value, and optional rangeString, that is the pie chart range list in the format of "0-20,21-50,51-75,76-100". | v1 v2 v3 v4
GET Device Down Message GET op/statisticsService/device/downMessage | Gets the device down message statistics. | v1 v2 v3 v4
GET Device Health Info GET op/statisticsService/device/healthInfo | Gets the device health info statistics. | v1 v2 v3 v4
GET Device Metric Data GET op/statisticsService/devices/metrics/{metric} | Fetches the metric data for the device. Data are represented by a list of pairs. Each pair contains metric value and timestamp when this value was collected. | v1 v2 v3 v4
GET Device Metrics Supported GET op/statisticsService/devices/metrics | Fetches the URLs for various metrics of the device. | v1 v2 v3 v4
GET Device Port Summary GET op/statisticsService/device/portSummary | Get the Device Port Summary Statistics. | v1 v2 v3 v4
GET Device Reachability Status GET op/statisticsService/device/reachabilityStatus | Gets the device reachability status statistics. | v1 v2 v3 v4
GET Device Resource GET op/statisticsService/devices | Fetches the details of devices. | v1 v2 v3 v4
GET Host Details GET op/statisticsService/hosts | Deprecated Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices. | v1 v2 v3 v4
GET Host Metric Data GET op/statisticsService/hosts/metrics/{metric} | Deprecated Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices. To fetch the data for the following metrics 1. CPU Usage 2. CPU Ready 3. CPU Reserved 4. Memory Consumed 5. Memory Usage 6. Memory Swap Rate 7. Network Usage 8. Network Drop 9. Network Error 10. Tx Drop 11. Rx Drop 12. Tx Error 13. Rx Error | v1 v2 v3 v4
GET Host Metrics Supported GET op/statisticsService/hosts/metrics | Deprecated Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices. To fetch the URLs for the following metrics 1. CPU Usage 2. CPU Ready 3. CPU Reserved 4. Memory Consumed 5. Memory Usage 6. Memory Swap Rate 7. Network Usage 8. Network Drop 9. Network Error 10. Tx Drop 11. Rx Drop 12. Tx Error 13. Rx Error | v1 v2 v3 v4
GET Interface Availability GET op/statisticsService/interface/availability | Gets the availability of the given interface. | v1 v2 v3 v4
GET Interface Availability Message GET op/statisticsService/interface/availMessage | Gets the available message of the given interface. | v1 v2 v3 v4
GET Interface Availability Summary GET op/statisticsService/interface/availabilitySummary | Gets a summary of the interface availability. | v1 v2 v3 v4
GET Interface Details GET op/statisticsService/interface/details | Retrieves all details for a specific interface. | v1 v2 v3 v4
GET Interface Discards GET op/statisticsService/interface/discards | Gets the discards of the given interface. | v1 v2 v3 v4
GET Interface Down Message GET op/statisticsService/interface/downMessage | Gets the down messages for the interface of the given device. | v1 v2 v3 v4
GET Interface Errors GET op/statisticsService/interface/errors | Gets the errors of the given interface. | v1 v2 v3 v4
GET Interface Metric Data GET op/statisticsService/interfaces/metrics/{metric} | Fetches the metric data for an Interface | v1 v2 v3 v4
GET Interface Metrics Supported GET op/statisticsService/interfaces/metrics | Fetches the URLs for various metrics of an Interface | v1 v2 v3 v4
GET Interface Resource GET op/statisticsService/interfaces | Retrieves common information for all interfaces or a specific interface. List of details contains only "IfIndex", "Device Name" and "Device IP Address" | v1 v2 v3 v4
GET Interface Status Summary GET op/statisticsService/interface/statusSummary | Gets the status summary of the given interface. | v1 v2 v3 v4
GET Memory Utilization Trend GET op/statisticsService/device/memoryUtilTrend | Gets the Memory Utilization Trend Statistics. | v1 v2 v3 v4
GET OutStanding IMEs For Site GET op/pfrMonitoringExt/getOutStandingIMEsForSite/{startTime}/{endTime}/{srcSite} | getOutStandingIMEsForSite | v1 v2 v3 v4
GET Reachable UCI Devcies GET op/device-rest/UciDeviceReachability/{groupId}/{startTime}/{endTime}/{maxrecords} |  | v1 v2 v3 v4
GET Refresh App Cache GET op/pfrMonitoringExt/refreshAppCache |  | v1 v2 v3 v4
GET Resource Types Supported GET op/statisticsService/resourceTypes | Gives the resource types that has performance metrics | v1 v2 v3 v4
GET Site App Health GET op/pfrMonitoringExt/getSiteAppHealth/{startTime}/{endTime} | getSiteAppHealth | v1 v2 v3 v4
GET System Information GET op/statisticsService/system/info | Gets the system information statistics, such as server name, number of jobs schedule/running, number of users, and more. | v1 v2 v3 v4
GET Top N Class Map QOS GET op/statisticsService/interface/topNClassMapQOS |  | v1 v2 v3 v4
GET Top N Device CPU Utilization GET op/statisticsService/device/topNCPU | Gets the top N Device CPU Utilization statistics. | v1 v2 v3 v4
GET Top N Device Memory Utilization GET op/statisticsService/device/topNMemory | Gets the top N device Memory Utilization statistics. | v1 v2 v3 v4
GET Top N Device Temperature GET op/statisticsService/device/topNTemp | Gets the top N Device Temperature statistics. | v1 v2 v3 v4
GET Top N Interface Errors GET op/statisticsService/interface/topNErrors | Gets the top N interfaces based on errors. | v1 v2 v3 v4
GET Unreachable UCI Devcies GET op/device-rest/UnReachableUciDevice/{groupId}/{startTime}/{endTime}/{maxrecords} |  | v1 v2 v3 v4
GET VM Details GET op/statisticsService/vms | Deprecated Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices. Fetches the details of VMs | v1 v2 v3 v4
GET VM Metric Data GET op/statisticsService/vms/metrics/{metric} | Deprecated Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices. To fetch the data for the following metrics 1. CPU Usage 2. CPU Ready 3. Memory Granted 4. Memory Usage 5. Memory Swap Rate 6. Network Usage 7. Network Drop 8. Network Error 9. Tx Drop 10. Rx Drop 11. Tx Error 12. Rx Error 13. Disk Rate 14. Disk Latency | v1 v2 v3 v4
GET VM Metrics Supported GET op/statisticsService/vms/metrics | Deprecated Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices. To fetch the URLs for the following metrics 1. CPU Usage 2. CPU Ready 3. Memory Granted 4. Memory Usage 5. Memory Swap Rate 6. Network Usage 7. Network Drop 8. Network Error 9. Tx Drop 10. Rx Drop 11. Tx Error 12. Rx Error 13. Disk Rate 14. Disk Latency | v1 v2 v3 v4
POST DSCP vs All TCA POST op/pfrMonitoringExt/getDSCPvsAllTCAViaPost/{startTime}/{endTime} | getDSCPvsAllTCAViaPost | v1 v2 v3 v4
POST DSCP vs UrTCA POST op/pfrMonitoringExt/getDSCPvsUrTCAViaPost/{startTime}/{endTime} | getDSCPvsUrTCAViaPost | v1 v2 v3 v4
POST Max Delay Vs DSCP Chart Reports POST op/pfrMonitoringExt/getMaxDelayVsDSCPChartReportsViaPost/{startTime}/{endTime} |  | v1 v2 v3 v4
POST Max Jitter Vs DSCP Chart Reports POST op/pfrMonitoringExt/getMaxJitterVsDSCPChartReportsViaPost/{startTime}/{endTime} |  | v1 v2 v3 v4
POST Max Packet Loss Vs DSCP Chart Reports POST op/pfrMonitoringExt/getMaxPacketLossVsDSCPChartReportsViaPost/{startTime}/{endTime} |  | v1 v2 v3 v4
POST Pfr Event List POST op/pfrMonitoringExt/getPfrEventListViaPost/{startTime}/{endTime} |  | v1 v2 v3 v4
POST Service Provider Usage Vs DSCP Chart POST op/pfrMonitoringExt/getServiceProviderUsageVsDSCPChart/{startTime}/{endTime}/{topN} | getServiceProviderUsageVsDSCPChart | v1 v2 v3 v4

## 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
--- | --- | ---
GET SyncE Available Metrics GET op/statisticsService/synce/metrics | Fetches all metrics that are collected for a specific SyncE node, as well as the URL of the next step ("SyncE Performance Data") that is available under the "url" element. Available metrics are: SyncE Quality Level Input, SyncE Quality Level Selected and SyncE Priority Example: op/statisticsService/synce/metrics?device=10.56.23.109 | v1 v2 v3 v4
GET SyncE Details GET op/statisticsService/synce | Fetches the SyncE node details per device, in addition to the URL for the next step that is available under the "metricsLink" element. Example: op/statisticsService/synce Example: op/statisticsService/synce?device=10.56.23.109 | v1 v2 v3 v4
GET SyncE performance Data GET op/statisticsService/synce/metrics/{metric} | Fetches performance measurements of a given metric for a specific SyncE node over a given period. For some metrics, it will also include the clock's state (OK/Degraded/Failure) Example: op/statisticsService/synce/metrics/?timeInterval=6&metricDataType=TIME_SERIES &device=10.56.23.109 | v1 v2 v3 v4

## System Settings

System Settings

Resource | Description | API Version
--- | --- | ---
DELETE WLAN FTP Server DELETE op/settings/servers/ftpServers/{serverName} | Deletes existing FTP server. | v1 v2 v3 v4
GET Alarms notification settings GET op/settings/notification/alarmCategories | Retrieves current alarms notification settings | v1 v2 v3 v4
GET Basic parameters for the configuration archive GET op/settings/inventory/configArchiveBasic | Retrieves basic parameters for the configuration archive, such as protocol, timeout value, number of configuration versions to store, and so forth. | v1 v2 v3 v4
GET Configuration for Automatic Deletion Periods of Alarms GET op/settings/alarms/alarmDeletionPeriods | Retrieves configuration for automatic deletion periods of alarms | v1 v2 v3 v4
GET Current general logging options GET op/settings/logging/generalLoggingOptions | Retrieves current general logging options with log modules names in alphabet case insensitive order. | v1 v2 v3 v4
GET Data Pruning Configuration GET op/settings/data/pruneDataConfig/{tableName} | Retrieves data pruning configuration for particular table. | v1 v2 v3 v4
GET Data Pruning Configuration for Category GET op/settings/data/pruneDataConfigsByGroup/{category} | Retrieves data pruning configurations for given category. | v1 v2 v3 v4
GET Data Retention Periods GET op/settings/data/dataRetentionPeriods | Retrieves data retention periods configured. | v1 v2 v3 v4
GET List of WLAN FTP Servers GET op/settings/servers/ftpServers | Retrieves the list of FTP servers. | v1 v2 v3 v4
GET Log file names GET op/settings/logging/logFileNames | Retrieves names of log files used by each logger category. | v1 v2 v3 v4
GET Mail Server settings GET op/settings/notification/mailServer | Retrieves current Mail Server configuration | v1 v2 v3 v4
GET SNMP settings GET op/settings/logging/snmpSettings | Retrieves SNMP settings. | v1 v2 v3 v4
GET Severity and Auto Clear Config GET op/settings/alarms/severityAutoClearConfig | Retrieves existing configuration for alarms. Returns tree of alarm types groups containing all alarms with their severities and auto clear ages if configured. | v1 v2 v3 v4
GET System log settings GET op/settings/logging/sysLogSettings | Retrieves system log settings. | v1 v2 v3 v4
POST Add WLAN FTP Server POST op/settings/servers/ftpServers | Adds new FTP server. | v1 v2 v3 v4
PUT Update Configuration for Automatic Deletion Periods of Alarms PUT op/settings/alarms/alarmDeletionPeriods | Updates configuration for automatic deletion periods of alarms | v1 v2 v3 v4
PUT Update Data Pruning Configuration PUT op/settings/data/pruneDataConfig/{tableName} | Updates data pruning configuration for particular table. | v1 v2 v3 v4
PUT Update Data Retention Periods PUT op/settings/data/dataRetentionPeriods | Updates configuration of data retention periods. | v1 v2 v3 v4
PUT Update Mail Server settings PUT op/settings/notification/mailServer | Updates current Mail Server configuration | v1 v2 v3 v4
PUT Update SNMP settings PUT op/settings/logging/snmpSettings | Updates SNMP settings. | v1 v2 v3 v4
PUT Update Severity and Auto Clear Config PUT op/settings/alarms/severityAutoClearConfig | Updates alarm settings for passed types changing severities and auto clear ages. | v1 v2 v3 v4
PUT Update WLAN FTP Server PUT op/settings/servers/ftpServers | Updates an existing FTP server. The server name attribute must match the existing server to be modified, and cannot be changed. | v1 v2 v3 v4
PUT Update alarms notification settings PUT op/settings/notification/alarmCategories | Updates current alarms notification settings | v1 v2 v3 v4
PUT Update basic parameters for the configuration archive PUT op/settings/inventory/configArchiveBasic | Updates basic parameters for the configuration archive, such as protocol, timeout value, number of configuration versions to store, and so forth. | v1 v2 v3 v4
PUT Update general logging options PUT op/settings/logging/generalLoggingOptions | Updates general logging options for passed arguments. | v1 v2 v3 v4
PUT Update system log settings PUT op/settings/logging/sysLogSettings | Updates system log settings. | v1 v2 v3 v4

## 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
--- | --- | ---
GET TDM and Sonet Available Port Metrics GET op/statisticsService/tdm/{section}/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 | v1 v2 v3 v4
GET TDM and Sonet Port Details GET op/statisticsService/tdm | 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 | v1 v2 v3 v4
GET TDM and Sonet Port Metric Data GET op/statisticsService/tdm/{section}/metrics/{metric} | 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 | v1 v2 v3 v4

## Trap Receivers

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

Resource | Description | API Version
--- | --- | ---
DELETE Delete Trap Receiver DELETE op/trapReceiverService/receiver | Deprecated Notification Receivers API is deprecated because Notification Receivers were replaced by Notification Policies. This resource will not delete receivers which (1) are used by more than one policy or (2) have other receivers associated with the same policy. This resource may be removed in a future release. Deletes an existing northbound trap receiver destination and the associated notification policy. The API supports only those trap receivers associated with one notification policy. If there is more than one policy mapped to the receiver, or the the policy is associated with any other receiver, then an explicit error will be thrown, and neither the receiver nor the policy will be deleted. | v1 v2 v3 v4
GET List Trap Receivers GET op/trapReceiverService/list | Deprecated Notification Receivers API is deprecated because Notification Receivers were replaced by Notification Policies. This resource will not list receivers which (1) are used by more than one policy or (2) have other receivers associated with the same policy. This resource may be removed in a future release. Retrieves certain existing northbound trap receiver destinations with the associated notification policy. Notification Policies underwent significant changes in Prime Infrastructure 3.2, therefore the API works with the following restrictions: The API will return only those trap receivers associated with one notification policy. If there is more than one policy mapped to the receiver, or the policy is associated with any other receiver, then the API won't return it. Trap receivers that do not meet these restrictions won't be included to the response. Notification Policies provide a more flexible way to configure category, device group, and severity filters. When any event type is selected in an alarm category, then the API will include this event category in the list of category filters. When any device type is selected under a device product family group, then the API will include this product family in the list of category filters. The API returns severity filters as a superset of all of the event type and alarm category severities selected in the notification policy. The "Clear" severity was removed and will no longer be returned by the API. | v1 v2 v3 v4
POST Create Trap Receiver POST op/trapReceiverService/receiver | Deprecated Notification Receivers API is deprecated because Notification Receivers were replaced by Notification Policies. This resource may be removed in a future release. Create a new northbound trap receiver destination with an associated notification policy. Notification Policies underwent significant changes in Prime Infrastructure 3.2, therefore the API works with the following restrictions: The API creates one or two notification policies depending on the provided alarm category filters: The first policy is created if default or "System" alarm categories are specified. The notification policy will contain a filter on event types which are in the selected alarm categories and have a severity matching the severities filter. The name of the policy is the same as the notification receiver name. If the alarm categories contain product families, then another notification policy will be created for the notification receiver. This notification policy will contain a filter on the selected product families and alarm severities. The name of the policy is the notification receiver name plus the "_PF" suffix. Note that the notification receiver won't be supported by the other Trap Receiver APIs if it is associated with two notification policies. The notification receiver name and the policies names must be unique. The "Clear" severity was deprecated. It will be silently ignored if passed in. | v1 v2 v3 v4
PUT Update Trap Receiver PUT op/trapReceiverService/receiver | Deprecated Notification Receivers API is deprecated because Notification Receivers were replaced by Notification Policies. This resource will not update receivers which (1) are used by more than one policy or (2) have other receivers associated with the same policy. This resource may be removed in a future release. Updates an existing northbound trap receiver destination and the associated notification policy. Notification Policies underwent significant changes in Prime Infrastructure 3.2, therefore the API works with the following restrictions: The API supports only those trap receivers associated with one notification policy. If there is more than one policy mapped to the receiver, or the policy is associated with any other receiver, then an explicit error will be thrown, and the receiver will not be updated. When the notification receiver is updated, then one additional policy may be created, depending on the provided alarm category filters: If the policy does not currently have default or "System" alarm categories, and they are added, an additional policy will be created. The notification policy will contain a filter on the event types which are in the selected alarm categories and have a severity matching the severities filter. The name of the policy is the same as the notification receiver name. If the policy does not currently have product family categories, and they are added, an additional policy will be created for notification receiver. This notification policy will contain filters on the selected product families and alarm severities. The name of the policy is the notification receiver name plus the "_PF" suffix. Note that after the update, the notification receiver won't be supported by the other Trap Receiver APIs if it is associated with two notification policies. The notification receiver name must be unique. Created notification policy has the same name as notification receiver's therefore there should not be existing notification policy with this name. The "Clear" severity was deprecated. It will be silently ignored if passed in. | v1 v2 v3 v4

## User Defined Field Management

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

Resource | Description | API Version
--- | --- | ---
GET User Defined Field Definition GET data/UserDefinedFieldDefinition | Provides a view of the User Defined Field Definitions of the system | v1 v2 v3 v4
PUT Delete User Defined Field Definition PUT op/udfService/deleteUserTagDefinition | An operation to delete User Defined Field definitions | v1 v2 v3 v4
PUT Import User Defined Field Definition PUT op/udfService/importUserTagDefinition | An operation to create or update User Defined Field definitions. | v1 v2 v3 v4

## User Management Service

Provides services to create, retrieve, update and delete users

Resource | Description | API Version
--- | --- | ---
DELETE Delete user DELETE op/userManagement/users | Deletes a user | v1 v2 v3 v4
GET Get user groups GET op/userManagement/userGroups | Returns list of user groups | v1 v2 v3 v4
GET Get users GET op/userManagement/users | Returns list of users | v1 v2 v3 v4
POST Create user POST op/userManagement/users | Creates a new user | v1 v2 v3 v4
PUT Update user PUT op/userManagement/users | Updates an existing user. User name is used to identify the user to be edited | v1 v2 v3 v4

## VNF Provisioning

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

Resource | Description | API Version
--- | --- | ---
GET Get Bridges GET op/nfv/getBridges | Get bridges. | v1 v2 v3 v4
GET Get Deployments GET op/nfv/getDeployments | Get VNF deployments. | v1 v2 v3 v4
GET Get Device Details GET op/nfv/deviceDetails | Get device details. | v1 v2 v3 v4
GET Get OVS Bridges GET op/nfv/getOvsBridges | Get OVS bridges. | v1 v2 v3 v4
GET Get Services GET op/nfv/getServices | Get services from NfVOS. | v1 v2 v3 v4
POST Add Bridge POST op/nfv/addBridge | Add a bridge. | v1 v2 v3 v4
POST Add Device POST op/virtual/addDevice | Add a device. | v1 v2 v3 v4
POST Create OVS Bridge POST op/nfv/createOvsBridge | Create an OVS bridge. | v1 v2 v3 v4
POST Delete Bridge POST op/nfv/deleteBridge | Delete a bridge. | v1 v2 v3 v4
POST Delete OVS Bridge POST op/nfv/deleteOvsBridge | Delete an OVS bridge. | v1 v2 v3 v4
POST Deploy Service POST op/nfv/deploy | Deploy a service on NfVOS. | v1 v2 v3 v4
POST Register Service POST op/nfv/register | Register a service on NfVOS. | v1 v2 v3 v4
POST Un-Deploy Service POST op/nfv/undeploy | Undeploy a service on NfVOS. | v1 v2 v3 v4
POST Un-Register Service POST op/nfv/unregister | Unregister a service on NfVOS. | v1 v2 v3 v4
PUT Update Bridge PUT op/nfv/updateBridge | Update Bridge | v1 v2 v3 v4
PUT Update OVS Bridge PUT op/nfv/updateOvsBridge | Update OVS Bridge | v1 v2 v3 v4

## Virtual Domains Management Service

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

Resource | Description | API Version
--- | --- | ---
GET Access Points associated with current Virtual Domain GET data/VDAssociatedAccessPoints | Represents an Access Point (Autonomous, Unified or Thirdparty) associated with a virtual domain. | v1 v2 v3 v4
GET Dynamic Groups associated with current Virtual Domain GET data/VDAssociatedDynamicGroups | Represents a Location or User Defined group assigned to a current virtual domain. Network devices assigned to dynamic groups will be associated with the virtual domain automatically. This API is not intended for ROOT-DOMAIN, for ROOT-DOMAIN the API returns all groups including Device Type groups. | v1 v2 v3 v4
GET Groups associated with current Virtual Domain GET data/VDAssociatedGroups | Represents a Location or User Defined group explicitly assigned to a current virtual domain. This API is not intended for ROOT-DOMAIN, for ROOT-DOMAIN the API returns all groups including Device Type groups. | v1 v2 v3 v4
GET Network Devices associated with current Virtual Domain GET data/VDAssociatedDevices | Represents a Network Device associated with a virtual domain. | v1 v2 v3 v4
GET Site Maps associated with current Virtual Domain GET data/VDAssociatedSiteMaps | Represents a Site Map associated with a virtual domain. | v1 v2 v3 v4
GET Virtual Elements associated with current Virtual Domain GET data/VDAssociatedVirtualElements | Represents a Virtual Element associated with a virtual domain. | v1 v2 v3 v4
DELETE Delete Virtual Domain DELETE op/vd | Deletes an existing virtual domain. Fully qualified domain name is used to identify the domain to be deleted | v1 v2 v3 v4
GET List Virtual Domains GET op/vd | Returns the list of virtual domains. The parentDomainName request parameter can be used to return all subdomains of a particular domain. | v1 v2 v3 v4
POST Create Virtual Domain POST op/vd | Creates a new virtual domain | v1 v2 v3 v4
PUT Update Virtual Domain PUT op/vd | Updates existing virtual domain. Fully qualified domain name is used to identify the domain to be edited | v1 v2 v3 v4

## Virtual Image Repository

Provides operations to query and manage the Virtual Image Repository

Resource | Description | API Version
--- | --- | ---
DELETE Delete Image by id DELETE op/image/id | Delete the image with the supplied ID | v1 v2 v3 v4
GET List Image by id GET op/image/list/id | List the details of the image with the given ID | v1 v2 v3 v4
GET List Images GET op/image/list | List the details of all NFV images in PI | v1 v2 v3 v4
GET List Images by family GET op/image/list/family | List the details of all NFV images with the given family name | v1 v2 v3 v4
GET List Physical Images GET op/image/list/physical | List all Physical images in the repository | v1 v2 v3 v4
GET List Virtual Images GET op/image/list/virtual | List all Virtual images in the repository | v1 v2 v3 v4
POST Add Image POST op/image/add | Add an image file to the repository | v1 v2 v3 v4
POST Deploy Configuration POST op/image/deployConfigure | Configure the deployment with the provided details | v1 v2 v3 v4

## WLAN Provisioning

Services to manage WLAN Controllers, it provides operations to retrieve, create, modify, and delete interfaces, WLAN profiles, and AP groups.

Resource | Description | API Version
--- | --- | ---
GET Wlan Profiles GET data/WlanProfiles | Provides information about WLANs present on controllers managed by this system. | v1 v2 v3 v4
GET Wlan Templates GET data/WlanTemplates | Provides information about WLAN templates stored on this system. | v1 v2 v3 v4
DELETE Delete AP Group DELETE op/wlanProvisioning/apGroup | Schedules a job to delete an AP group from a Wlan Controller. | v1 v2 v3 v4
DELETE Delete Interface DELETE op/wlanProvisioning/interface | Schedules a job to delete an interface from a Wlan Controller. | v1 v2 v3 v4
DELETE Delete Interface Group DELETE op/wlanProvisioning/interfaceGroup | Schedules a job to delete an interface group from a Wlan Controller. | v1 v2 v3 v4
DELETE Delete WLAN Profile DELETE op/wlanProvisioning/wlanProfile | Schedules a job to delete a WLAN profile from a Wlan Controller. | v1 v2 v3 v4
DELETE Delete Wlan Template DELETE op/wlanProvisioning/wlanTemplate | Removes a WLAN template from the server. | v1 v2 v3 v4
POST Create AP Group POST op/wlanProvisioning/apGroup | Schedules a job to create an AP group on a Wlan Controller. | v1 v2 v3 v4
POST Create Interface POST op/wlanProvisioning/interface | Schedules a job to create an interface on a Wlan Controller. | v1 v2 v3 v4
POST Create Interface Group POST op/wlanProvisioning/interfaceGroup | Schedules a job to create an interface group on a Wlan Controller. | v1 v2 v3 v4
POST Create Wlan Template POST op/wlanProvisioning/wlanTemplate | Creates a WLAN template on the server. | v1 v2 v3 v4
PUT Deploy Wlan Template PUT op/wlanProvisioning/deployTemplate | Schedules a job to deploy a WLAN template onto a Wlan Controller, creating a WLAN profile. | v1 v2 v3 v4
PUT Modify AP Group PUT op/wlanProvisioning/apGroup | Schedules a job to modify an existing AP group on a Wlan Controller. The apGroupName attribute must match the existing AP group to be modified, and cannot be changed. | v1 v2 v3 v4
PUT Modify Interface PUT op/wlanProvisioning/interface | Schedules a job to modify an existing interface on a Wlan Controller. The interfaceName attribute must match the existing interface to be modified, and cannot be changed. | v1 v2 v3 v4
PUT Modify Interface Group PUT op/wlanProvisioning/interfaceGroup | Schedules a job to modify an existing interface group on a Wlan Controller. The interfaceGroupName attribute must match the existing interface group to be modified, and cannot be changed. | v1 v2 v3 v4
PUT Modify Wlan Template PUT op/wlanProvisioning/wlanTemplate | Modifies an existing WLAN template on the server. The template name must match an existing template. | v1 v2 v3 v4

## Wireless Device Details

The Wireless Device Details category provides detailed information about the managed wireless devices.

Resource | Description | API Version
--- | --- | ---
GET Autonomous AP Radio Details GET data/AutoApRadioDetails | Represents a radio interface of an autonomous access point. | v1 v2 v3 v4
GET Client Statistics GET data/ClientStats | Represents the latest polled client statistics data. The data represented here are the counters retrieved from controllers. The counters only get reset in new sessions. | v1 v2 v3 v4
GET Historical Client Statistics GET data/HistoricalClientStats | Represents client statistics collected in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying it, it is better to use paged query or filtered by client or time. | v1 v2 v3 v4
GET Historical Radio Interface 802.11 Counters in Last 24 Hours GET data/HistoricalRFCounters | 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. | v1 v2 v3 v4
GET Historical Radio Interface Load Statistics in Last 24 Hours GET data/HistoricalRFLoadStats | Represents load statistics for radio interfaces of lightweight wireless access points collected in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying it, it is better to use paged query or filtered by AP or time. | v1 v2 v3 v4
GET Historical Radio Interface Statistics in Last 24 Hours GET data/HistoricalRFStats | 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. | v1 v2 v3 v4
GET Historical Wireless LAN Controller CPU Utilizations GET data/HistoricalWLCCPUUtilizations | Represents the historical CPU utilization information collected from WLAN controllers in past 24 hours. | v1 v2 v3 v4
GET Historical Wireless LAN Controller Memory Utilizations GET data/HistoricalWLCMemUtilizations | Represents the historical memory utilization information collected from WLAN controllers in past 24 hours. | v1 v2 v3 v4
GET Historical Wireless LAN Controller Utlizations GET data/HistoricalWLCUtilizations | Deprecated Do not use this resource. Replaced by Historical Wireless LAN Controller CPU Utilizations and Historical Wireless LAN Controller Memory Utilizations. Represents the historical CPU and memory utilization information collected from WLAN controllers in past 24 hours. | v1 v2 v3 v4
GET Lightweight AP Radio Details GET data/RadioDetails | Represents detail information of a radio interfaces on lightweight access point. | v1 v2 v3 v4
GET Radio Interface 802.11 Counters GET data/RFCounters | Represents the latest 802.11 counters for radio interfaces of lightweight wireless access points collected from controllers. | v1 v2 v3 v4
GET Radio Interface Load Statistics GET data/RFLoadStats | Represents the latest load statistics information for radio interfaces of lightweight wireless access points collected from WLAN controllers. Note that when access points are in a dissociated state, the radio interface statistics presented by the RFLoadStats resource is not collected from WLAN controllers. When queried, the API presents information from the latest successful data collection event. | v1 v2 v3 v4
GET Radio Interface Statistics GET data/RFStats | Represents the latest statistics information for radio interfaces of lightweight wireless access points collected from WLAN controllers. Note that when access points are in a dissociated state, the radio interface statistics presented by the RFStats resource is not collected from WLAN controllers. When queried, RFStats presents information from the latest successful data collection event. Because radio interface statistics were not collected, the API will present an empty result for disassociated access point radio interfaces. If the dissociation(s) occurred within the last 24 hours, the data/HistoricalRFStats API resource may have more data. | v1 v2 v3 v4
GET Radio Summary GET data/Radios | Retrieves radio interfaces of lightweight and autonomous access points. You should use RadioDetails API for retrieving only radio interfaces of lightweight APs and AutoApRadioDetails API for only radio interfaces of autonomous APs. | v1 v2 v3 v4
GET Third Party Access Point Summary GET data/ThirdpartyAccessPoints | Represents a third party access point. It provides device attributes such as type, version, associated controller, number of associated clients, etc. | v1 v2 v3 v4
GET Wireless Access Point Details GET data/AccessPointDetails | Represents detail information of a wireless access points. It includes basic attributes, inventory, CDP, client and other information. Note: the API resource may return Meraki devices as access points. You can filter them out by adding "type=ne(MerakiAccessPoint)" query string. | v1 v2 v3 v4
GET Wireless Access Point Summary GET data/AccessPoints | Represents a wireless access point including both unified and autonomous. It provides device attributes such as type, version, association controller, number of associated client, etc. Note: the API resource may return Meraki devices as access points. You can filter them out by adding "type=isNull()" query string. | v1 v2 v3 v4
GET Wireless LAN Controller CPU Utlizations GET data/WLCCPUUtilizations | Represents the latest CPU utilization collected from a WLAN controller. | v1 v2 v3 v4
GET Wireless LAN Controller Details GET data/WlanControllerDetails | Represents detail information about a WLAN controller. | v1 v2 v3 v4
GET Wireless LAN Controller Memory Utilizations GET data/WLCMemoryUtilizations | Represents the latest memory utilization collected from a WLAN controller. | v1 v2 v3 v4
GET Wireless LAN Controller Summary GET data/WlanControllers | Represents summary information about a WLAN controller. | v1 v2 v3 v4
GET Wireless LAN Controller Utlizations GET data/WLCUtilizations | Deprecated Do not use this resource. Replaced by Wireless LAN Controller CPU Utlizations and Wireless LAN Controller Memory Utlizations. Represents the latest CPU and memory utilization collected from a WLAN controller. | v1 v2 v3 v4

## 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
--- | --- | ---
GET Y1731 Bins Available Metrics GET op/statisticsService/y1731bins/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 | v1 v2 v3 v4
GET Y1731 Bins Details GET op/statisticsService/y1731bins | 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 | v1 v2 v3 v4
GET Y1731 Bins performance Data GET op/statisticsService/y1731bins/metrics/{metric} | 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 | v1 v2 v3 v4