Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

REST API Resources

Configuration Archive Service

Provides services for configuration file, diff and versions operations.

Resource Description API Version
GET Bulk export sanitized configuration archives

GET data/BulkSanitizedConfigArchives

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

GET data/BulkUnsanitizedConfigArchives

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

GET op/configArchiveService/configDiff/{device}

Compute Running Configuration Diff. Currently supported only for router devices.

Device Operations

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.

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

PUT op/groups/groupInterfaces

Statically assign list of interfaces to given port group. Only 'User Defined' and 'WAN Interfaces' port groups are supported.
PUT Remove interfaces from a group

PUT op/groups/removeInterfaces

Remove a list of interfaces from a given port group. Only 'User Defined' and 'WAN Interfaces' port groups are supported.

Plug and Play

Provides operations related to Plug And Play

Resource Description API Version
DELETE Delete Pnp Profile

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

Deletes the exisiting Pnp profiles.
GET Get All Profile Instances of a PnP Profile

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

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

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

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

GET op/pnp/profile/{pnpProfileFolder}

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

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

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

POST op/pnp/profile/{pnpProfileFolder}

Creates Pnp profiles
POST Create or Update Profile Instances of a PnP Profile

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

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

PUT op/pnp/profile/{pnpProfileFolder}

Updates the existing pnp profiles

Software Updates

Provides information about Software Updates.

Resource Description API Version
GET Information about current platform

GET op/update/platformInfo

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

GET op/update/retrieve

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

  • Available states:
    • AVAILABLE
    • AVAILABLE_PENDING_RESTART
    • INSTALLED
    • INSTALLED_PENDING_RESTART
    • ERROR_ON_INSTALL
    • ERROR_ON_ROLLBACK

Statistics

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

Resource Description API Version
GET All Border Routers

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

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

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

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

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

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

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

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

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

Fetches all the WAN Interface details active within a specific time range for a given site and its Border Router.The URL format is:/op/pfrMonitoringExt/getAllWANInterfaces/startTime/endTime/siteName/brIp?srcHierarchyPath. Here are the sample queries:
  • /op/pfrMonitoringExt/getAllWANInterfaces/1475824562/1476429362/BANGALORE/150.150.0.35 -- Returns the WAN interface active details for the given site and device ip within startTime and endTime.
  • /op/pfrMonitoringExt/getAllWANInterfaces/1475824562/1476429362/BANGALORE/150.150.0.35?srcHierarchyPath=/Location/All locations -- Returns the WAN interface active details for the given site and device ip under srcHierarchyPath within StartTime and endTime.
GET Cluster Details

GET op/statisticsService/clusters

Fetches the details of Clusters
GET Cluster Metric Data

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

Fetches the metric data for a Cluster
GET Cluster Metrics Supported

GET op/statisticsService/clusters/metrics

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

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

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

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

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

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

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

GET op/statisticsService/datacenters

Fetches the details of Datacenters
GET Datacenter Metric Data

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

No metrics are available for Datacenters
GET Datacenter Metrics Supported

GET op/statisticsService/datacenters/metrics

No metrics are available for Datacenters
GET Device Metric Data

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

Fetches the metric data for the device.
GET Device Metrics Supported

GET op/statisticsService/devices/metrics

Fetches the URLs for various metrics of the device.
GET Device Resource

GET op/statisticsService/devices

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

GET op/statisticsService/hosts

Fetches the details of Hosts
GET Host Metric Data

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

Fetches the metric data for a Host
GET Host Metrics Supported

GET op/statisticsService/hosts/metrics

Fetches the URLs for various metrics of a Host
GET Interface Metric Data

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

Fetches the metric data for an Interface

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

GET op/statisticsService/interfaces/metrics

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

GET op/statisticsService/interfaces

Fetches the basic details of interfaces and REST URL links to their children and metrics
GET Lisp Map Summary Trend

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

Retrieves the lisp map-cache size over time trend for a given device in the selected time interval
GET OutStanding IMEs For Site

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

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

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

Fetches UCI Reachable Devices
GET Refresh App Cache

GET op/pfrMonitoringExt/refreshAppCache

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

GET op/statisticsService/resourceTypes

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

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

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

GET op/statisticsService/applications/appHealthCrossing

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

GET op/statisticsService/applications/performance

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

GET op/statisticsService/applications/overtime

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

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

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

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

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

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

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

GET op/statisticsService/applications/appCount

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

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

Fetches UCI Unreachable Devices
GET VM Details

GET op/statisticsService/vms

Fetches the details of VMs
GET VM Metric Data

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

Fetches the metric data for a VM
GET VM Metrics Supported

GET op/statisticsService/vms/metrics

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

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

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

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

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

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

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

Sample PostBody:

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

POST DSCP vs UrTCA

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

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

Sample PostBody:

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

POST Max Delay Vs DSCP Chart Reports

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

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

Sample PostBody:

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

POST Max Jitter Vs DSCP Chart Reports

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

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

Sample PostBody:

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

POST Max Packet Loss Vs DSCP Chart Reports

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

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

Sample PostBody:

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

POST Pfr Event List

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

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

Sample PostBody:

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

POST Service Provider Usage Vs DSCP Chart

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

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

Sample PostBody:

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

VNF Provisioning

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

Resource Description API Version
GET Get Bridges

GET op/nfv/getBridges

Get bridges.
GET Get Deployments

GET op/nfv/getDeployments

Get VNF deployments.
GET Get Device Details

GET op/nfv/deviceDetails

Get device details.
GET Get OVS Bridges

GET op/nfv/getOvsBridges

Get OVS bridges.
GET Get Services

GET op/nfv/getServices

Get services from NfVOS.
POST Add Bridge

POST op/nfv/addBridge

Add a bridge.
POST Add Device

POST op/virtual/addDevice

Add a device.
POST Create OVS Bridge

POST op/nfv/createOvsBridge

Create an OVS bridge.
POST Delete Bridge

POST op/nfv/deleteBridge

Delete a bridge.
POST Delete OVS Bridge

POST op/nfv/deleteOvsBridge

Delete an OVS bridge.
POST Deploy Service

POST op/nfv/deploy

Deploy a service on NfVOS.
POST Register Service

POST op/nfv/register

Register a service on NfVOS.
POST Un-Deploy Service

POST op/nfv/undeploy

Undeploy a service on NfVOS.
POST Un-Register Service

POST op/nfv/unregister

Unregister a service on NfVOS.
PUT Update Bridge

PUT op/nfv/updateBridge

Update Bridge
PUT Update OVS Bridge

PUT op/nfv/updateOvsBridge

Update OVS Bridge

Virtual Image Repository

Provides operations to query and manage the Virtual Image Repository

Resource Description API Version
DELETE Delete Image by id

DELETE op/image/id

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

GET op/image/list/id

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

GET op/image/list

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

GET op/image/list/family

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

GET op/image/list/physical

List all Physical images in the repository
GET List Virtual Images

GET op/image/list/virtual

List all Virtual images in the repository
POST Add Image

POST op/image/add

Add an image file to the repository
POST Deploy Configuration

POST op/image/deployConfigure

Configure the deployment with the provided details

Wireless Device Details

The Wireless Device Details category provides detailed information about the managed wireless devices.
Resource Description API Version
GET Historical Wireless Lan Controller CPU Utilizations

GET data/HistoricalWLCCPUUtilizations

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

GET data/HistoricalWLCMemUtilizations

Represents the historical memory utilization information collected from WLAN controllers in past 24 hours.
GET Wireless Lan Controller CPU Utlizations

GET data/WLCCPUUtilizations

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

GET data/WLCMemoryUtilizations

Represents the latest memory utilization collected from a WLAN controller.