Skip to main content
Cisco SD-WAN
Support
Product Documentation
Viptela Documentation

DPI

API calls for real-time monitoring of DPI information:

Applications

Display application-aware applications running on the vEdge router (on vEdge routers only).

CLI Equivalent: show app dpi applications

URL:https://vmanage-ip-address/dataservice/device/dpi/applications?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String
application Optional Application Query String
family Optional Family Query String
vpn-id Optional VPN ID Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Flows

Display flow information for the application-aware applications running on the vEdge router (on vEdge routers only).

CLI Equivalent: show app dpi flows

URL: https://vmanage-ip-address/dataservice/device/dpi/flows?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String
application Optional Application Query String
family Optional Family Query String
src-ip Optional Source IP Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Summary

Display summary statistics for DPI flows on the vEdge router (on vEdge routers only).

CLI Equivalent: show app dpi summary statistics

URL: https://vmanage-ip-address/dataservice/device/dpi/summary?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String
application Optional Application Query String
family Optional Family Query String
vpn-id Optional VPN ID Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Supported Applications

List all the application-aware applications supported by the Viptela software on the vEdge router (on vEdge routers only).

CLI Equivalent: show app dpi supported-applications

URL: https://vmanage-ip-address/dataservice/device/dpi/supported-applications?deviceId=deviceId

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device Query String
application Optional Application Query String
family Optional Family Query String

Response Content Type: application/json

Response Object: See Response Object, below.

Response Object for Real-Time Monitoring API Calls

Real-time monitoring API call responses have the following format:

{
  "header": {
    "generatedOn": timestamp, milliseconds (UNIX time format),                            
      "viewKeys": {
        "uniqueKey": ["key"]                       
      },
      "fields": [
        properties and types
      ],
   },
   "data": [
     array of objects
   ]
}

Additional Information

Using the vManage REST API

  • Was this article helpful?