Get application and category information
get
http://<SDWAN_TENANT_IP>/v1/admin/application/cumulativeUsage
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Root Schema : schema
Type:
object
401 Response
Not Logged into the SDWAN-Edge device
Root Schema : 401NotLoggedin
Type:
Show Source
object
-
message: string
Example:
Not logged in.
-
status: string
Example:
fail
403 Response
Insufficient Userlevel
Root Schema : 403InsufficientUserLevel
Type:
Show Source
object
-
message: string
Example:
User Level for user <user_name> is not sufficient for this <URL value> operation.
-
required_user_level: string
Example:
ADMIN
-
status: string
Example:
fail
-
user_level: string
Example:
GUEST
-
user_name: string
Example:
username
405 Response
Invalid request method
Root Schema : 405ExpectedGet
Type:
Show Source
object
-
message: string
Example:
Operation must use a GET
-
status: string
Example:
fail
Examples
Example of Accessing the API with cURL
The following example shows how to get the cumulative usage information based on all applications and categories by submitting a GET request on the REST resource using cURL. If the request requires a timestamp, use the timestamp from the response of the /login API. For more information about cURL, see Use cURL.
curl -X GET \
-b cookies.txt \
"https://$IPADDR/v1/admin/application/cumulativeUsage"
Example of the Response Body
The following example shows the contents of the response body in JSON format.
{
"data": [
[
{
"applicationResult": [
{
"results": [
{
"appID": 0,
"appName": "application_1",
"catName": "Other",
"totMB": 286,
"totMBytesR": 281,
"totMBytesRS": "281, 5",
"totMBytesS": 5
}
],
"timestamp": "5:43:20 on 5/20/2020"
}
],
"categoryResult": [
{
"results": [
{
"catAppCount": 16,
"catName": "Other",
"totMB": 286,
"totMBytesR": 281,
"totMBytesRS": "281, 5",
"totMBytesS": 5
}
],
"timestamp": "5:43:20 on 5/20/2020"
}
]
}
]
],
"status": "success"
}