Skip to main content
Viptela is now part of Cisco.
Support
Product Documentation
Viptela Documentation

Dashboard

API calls for retrieving information available in the vManage dashboard:

Alarm Count

Display a count of active and cleared alarms.

URL: https://vmanage-ip-address/dataservice/alarms/count

Method: GET

Response Content Type: application/json

Response Object: See Response Object, below.

Application-Aware Routing

Display application-aware routing information.

URL: https://vmanage-ip-address/dataservice/tunnels/summary/type

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
type Yes Metric type. The value can be jitter, latency, or loss_percentage. Path String
limit Optional Total number of tunnels. Query Integer

Response Content Type: application/json

Response Object: See Response Object, below.

Certificate Summary

Display information about certificates.

URL: https://vmanage-ip-address/dataservice/certificate/stats/summary

Method: GET

Response Content Type: application/json

Response Object: See Response Object, below.

Connections Summary

Display information about all connections in the overlay network.

URL: https://vmanage-ip-address/dataservice/network/connectionssummary

Method: GET

Response Content Type: application/json

Response Object: See Response Object, below.

Control Status

Display information about the status of control connections.

URL: https://vmanage-ip-address/dataservice/device/control/count

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
isCached Optional Displays information cached in the vManage database. By default, the call retrieves noncached information. Query Boolean

Response Content Type: application/json

Response Object: See Response Object, below.

Reboot Count

Display a count of reboot events in the last 24 hours.

URL: https://vmanage-ip-address/dataservice/network/issues/rebootcount

Method: GET

Response Content Type: application/json

Response Object: See Response Object, below.

Server Details

Display information about the vManage server, including the current time and timezone.

URL: https://vmanage-ip-address/dataservice/client/server

Method: GET

Response Content Type: application/json

Response Object: See Response Object, below.

Site Health View

Display information about data connections, including sites with full, partial, and no connectivity.

URL: https://vmanage-ip-address/dataservice/device/bfd/sites/summary

Method: GET

Response Content Type: application/json

Response Object: See Response Object, below.

Top Applications (DPI)

Display DPI information for traffic transiting vEdge routers in the overlay network.

URL: https://vmanage-ip-address/dataservice/statistics/dpi/applications/summary

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
limit Optional Limit the number of top applications to display. Query Integer
query Optional vManage sample query to filter applications by time and VPN. Query String (JSON)

Response Content Type: application/json

Response Object: See Response Object, below.

Top Destinations (Cflowd)

Display cflowd information for traffic transiting vEdge routers in the overlay network.

URL: https://vmanage-ip-address/dataservice/statistics/cflowd/applications/summary

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
limit Optional Limit the number of top applications to display. Query Integer
query Optional vManage sample query to filter applications by time and VPN. Query String (JSON)

Response Content Type: application/json

Response Object: See Response Object, below.

Transport Health

Display information about loss, latency, and jitter for all applications and all combinations of colors.

URL: https://vmanage-ip-address/dataservice/statistics/approute/transport/summary/type

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
type Required Metric type. The value can be jitter, latency, or loss_percentage. Path String
limit Optional Limit the number of top applications to display. Query Integer
query Optional vManage sample query to filter applications by time and VPN. Query String (JSON)

Response Content Type: application/json

Response Object: See Response Object, below.

Transport Interface Distribution

Display information about physical interface usage.

URL: https://vmanage-ip-address/dataservice/device/tlocutil

Method: GET

Response Content Type: application/json

Response Object: See Response Object, below.

User Roles

Display information about user roles.

URL: https://vmanage-ip-address/dataservice/client/user/roles

Method: GET

Response Content Type: application/json

Response Object: See Response Object, below.

vEdge Hardware Health

Display information about the health of vEdge routers in the overlay network.

URL: https://vmanage-ip-address/dataservice/device/hardwarehealth/summary

Method: GET

Request Parameters

Name Required Description Parameter Type Data Type
isCached Optional Displays information cached in the vManage database. By default, the call retrieves noncached information. Query Boolean

Response Content Type: application/json

Response Object: See Response Object, below.

vEdge Inventory

Display information about vEdge routers in the overlay network.

URL: https://vmanage-ip-address/dataservice/vedgeinventory/summary

Method: GET

Response Content Type: application/json

Response Object: See Response Object, below.

vManage List

Display information about vManage NMS servers in the overlay network.

URL: https://vmanage-ip-address/dataservice/clusterManagement/health/summary

Method: GET

Response Content Type: application/json

Response Object: See Response Object, below.

Response Object

Troubleshooting 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?