*API Template*
Intro phrase ending with a colon: (Example: API calls for real-time monitoring of DPI:)
- Bulleted list of API names with links to the sections
API Name
Intro (copy description from show command article).
URL: https://vmanage-ip-address/dataservice/ (add the rest of the url)
Method: GET/POST
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.
API Name
Intro (copy description from show command article).
URL: https://vmanage-ip-address/dataservice/ (add the rest of the url)
Method: GET/POST
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
]
}