services¶
Overview¶
API to get reports for services (bandwidth is in Kbps and data is in KB)
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/reports/
Schemes : HTTP
Tags¶
- services : Operations related to services
Paths¶
Get operation for services¶
GET /services
Description¶
Use this operation to get a report for services. The response payload also contains the meta_data block.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | services_response_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- services
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
data_coverage¶
The amount in percent, of the selected time period for which there is data
Type : number
lan_to_wan_bandwidth¶
The LAN to WAN Bandwidth for all packet types
Type : number
lan_to_wan_packets¶
The LAN to WAN packets for all packet types
Type : integer
lan_to_wan_packets_dropped¶
The LAN to WAN packets dropped
Type : integer
lan_to_wan_percent_drop¶
The LAN to WAN drop, in percent
Type : number
name¶
The site name
Type : string
region_name¶
The region name
Type : string
service_type¶
The Service Type (Virtual Path, Internet, Intranet or Passthrough)
Type : string
services_delete_success_schema¶
| Name | Schema |
|---|---|
| services optional |
services |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
services_post_success_schema¶
| Name | Schema |
|---|---|
| services optional |
services |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
services_put_success_schema¶
| Name | Schema |
|---|---|
| services optional |
services |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
services_response_schema¶
Type : < services_response_schema > array
| Name | Schema |
|---|---|
| data_coverage optional |
data_coverage |
| lan_to_wan_bandwidth optional |
lan_to_wan_bandwidth |
| lan_to_wan_packets optional |
lan_to_wan_packets |
| lan_to_wan_packets_dropped optional |
lan_to_wan_packets_dropped |
| lan_to_wan_percent_drop optional |
lan_to_wan_percent_drop |
| name optional |
name |
| region_name optional |
region_name |
| service_type optional |
service_type |
| wan_to_lan_bandwidth optional |
wan_to_lan_bandwidth |
| wan_to_lan_packets optional |
wan_to_lan_packets |
| wan_to_lan_packets_dropped optional |
wan_to_lan_packets_dropped |
| wan_to_lan_percent_drop optional |
wan_to_lan_percent_drop |
wan_to_lan_bandwidth¶
The WAN to LAN bandwidth for all packet types
Type : number
wan_to_lan_packets¶
The WAN to LAN packets for all packet types
Type : integer
wan_to_lan_packets_dropped¶
The WAN to LAN packets dropped
Type : integer
wan_to_lan_percent_drop¶
The WAN to LAN packets dropped
Type : number