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


API call for real-time monitoring of VPNs:


Display VPN instance list.

CLI Equivalent: show running-config vpn

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

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
deviceId Yes IP address of device 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?