virtual_paths¶
Overview¶
API to get reports for virtual paths (bandwidth is in Kbps and data is in KB)
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/reports/
Schemes : HTTP
Tags¶
- virtual_paths : Operations related to virtual_paths
Paths¶
Get operation for virtual_paths¶
GET /virtual_paths
Description¶
Use this operation to get a report for virtual paths. The response payload also contains the meta_data block.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | virtual_paths_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¶
- virtual_paths
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
bad_time¶
The time that the service was bad, in seconds
Type : string
bad_time_percent¶
The time, in percent that the service was bad
Type : number
data_coverage¶
The amount, in percent of the selected time period for which there is data
Type : number
down_time¶
The time that the service was unusable, in seconds
Type : string
down_time_percent¶
The time, in percent that the service was unusable
Type : number
good_time¶
The time that the service was good, in seconds
Type : string
good_time_percent¶
The time, in percent that the service was good
Type : number
ipsec_worst_state¶
The IPsec tunnel worst state observed during the time period
Type : string
lan_to_wan_bandwidth¶
The LAN to WAN Bandwidth for all packet types
Type : number
lan_to_wan_bulk_bandwidth¶
The LAN to WAN bulk bandwidth
Type : number
lan_to_wan_bulk_packets¶
The LAN to WAN bulk packets
Type : integer
lan_to_wan_control_bandwidth¶
The LAN to WAN Control Bandwidth
Type : number
lan_to_wan_control_packets¶
The LAN to WAN control packets
Type : integer
lan_to_wan_interactive_bandwidth¶
The LAN to WAN interactive bandwidth
Type : number
lan_to_wan_interactive_packets¶
The LAN to WAN interactive packets
Type : integer
lan_to_wan_max_bandwidth¶
The maximum LAN to WAN Bandwidth for all packet types
Type : number
lan_to_wan_min_bandwidth¶
The minimum 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_permitted bandwidth¶
The LAN to WAN permitted bandwidth
Type : number
lan_to_wan_realtime_bandwidth¶
The LAN to WAN Realtime Bandwidth
Type : number
lan_to_wan_realtime_packets¶
The LAN to WAN real-time packets
Type : integer
percent_up_time¶
The time, in percent that the service was usable
Type : number
region_name¶
The region name
Type : string
site_name¶
The site name
Type : string
up_time¶
The time that the service was usable, in seconds
Type : string
virtual_path_name¶
The virtual path name
Type : string
virtual_path_type¶
Virtual path type ( static or dynamic)
Type : string
virtual_paths_delete_success_schema¶
| Name | Schema |
|---|---|
| virtual_paths optional |
virtual_paths |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
virtual_paths_post_success_schema¶
| Name | Schema |
|---|---|
| virtual_paths optional |
virtual_paths |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
virtual_paths_put_success_schema¶
| Name | Schema |
|---|---|
| virtual_paths optional |
virtual_paths |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
virtual_paths_response_schema¶
Type : < virtual_paths_response_schema > array
| Name | Schema |
|---|---|
| bad_time optional |
bad_time |
| bad_time_percent optional |
bad_time_percent |
| data_coverage optional |
data_coverage |
| down_time optional |
down_time |
| down_time_percent optional |
down_time_percent |
| good_time optional |
good_time |
| good_time_percent optional |
good_time_percent |
| ipsec_worst_state optional |
ipsec_worst_state |
| lan_to_wan_bandwidth optional |
lan_to_wan_bandwidth |
| lan_to_wan_bulk_bandwidth optional |
lan_to_wan_bulk_bandwidth |
| lan_to_wan_bulk_packets optional |
lan_to_wan_bulk_packets |
| lan_to_wan_control_bandwidth optional |
lan_to_wan_control_bandwidth |
| lan_to_wan_control_packets optional |
lan_to_wan_control_packets |
| lan_to_wan_interactive_bandwidth optional |
lan_to_wan_interactive_bandwidth |
| lan_to_wan_interactive_packets optional |
lan_to_wan_interactive_packets |
| lan_to_wan_max_bandwidth optional |
lan_to_wan_max_bandwidth |
| lan_to_wan_min_bandwidth optional |
lan_to_wan_min_bandwidth |
| lan_to_wan_packets optional |
lan_to_wan_packets |
| lan_to_wan_permitted bandwidth optional |
lan_to_wan_permitted bandwidth |
| lan_to_wan_realtime_bandwidth optional |
lan_to_wan_realtime_bandwidth |
| lan_to_wan_realtime_packets optional |
lan_to_wan_realtime_packets |
| percent_up_time optional |
percent_up_time |
| region_name optional |
region_name |
| site_name optional |
site_name |
| up_time optional |
up_time |
| virtual_path_name optional |
virtual_path_name |
| virtual_path_type optional |
virtual_path_type |
| wan_to_lan_bandwidth optional |
wan_to_lan_bandwidth |
| wan_to_lan_best_one_way_time_latency_ms optional |
wan_to_lan_best_one_way_time_latency_ms |
| wan_to_lan_best_one_way_time_max_latency_ms optional |
wan_to_lan_best_one_way_time_max_latency_ms |
| wan_to_lan_best_one_way_time_min_latency_ms optional |
wan_to_lan_best_one_way_time_min_latency_ms |
| wan_to_lan_congestion_count optional |
wan_to_lan_congestion_count |
| wan_to_lan_max_bandwidth optional |
wan_to_lan_max_bandwidth |
| wan_to_lan_max_jitter_ms optional |
wan_to_lan_max_jitter_ms |
| wan_to_lan_max_percent_loss optional |
wan_to_lan_max_percent_loss |
| wan_to_lan_min_bandwidth optional |
wan_to_lan_min_bandwidth |
| wan_to_lan_min_jitter_ms optional |
wan_to_lan_min_jitter_ms |
| wan_to_lan_min_percent_loss optional |
wan_to_lan_min_percent_loss |
| wan_to_lan_mismatched_bandwidth optional |
wan_to_lan_mismatched_bandwidth |
| wan_to_lan_mismtached_packets optional |
wan_to_lan_mismtached_packets |
| wan_to_lan_packets optional |
wan_to_lan_packets |
| wan_to_lan_packets_loss optional |
wan_to_lan_packets_loss |
| wan_to_lan_packets_ooo optional |
wan_to_lan_packets_ooo |
| wan_to_lan_percent_loss optional |
wan_to_lan_percent_loss |
| wan_to_lan_percent_ooo optional |
wan_to_lan_percent_ooo |
| wan_to_lan_permitted_bandwidth optional |
wan_to_lan_permitted_bandwidth |
| worst_state optional |
worst_state |
wan_to_lan_bandwidth¶
The WAN to LAN bandwidth for all packet types
Type : number
wan_to_lan_best_one_way_time_latency_ms¶
The WAN to LAN best one way time latency in milliseconds
Type : integer
wan_to_lan_best_one_way_time_max_latency_ms¶
The maximum WAN to LAN best one way time latency in milliseconds
Type : integer
wan_to_lan_best_one_way_time_min_latency_ms¶
The minimum WAN to LAN best one way time latency in milliseconds
Type : integer
wan_to_lan_congestion_count¶
Congestion detected due to increased, unexpected delay in packet flow in the WAN
Type : string
wan_to_lan_max_bandwidth¶
The maximum WAN to LAN bandwidth for all packet types
Type : number
wan_to_lan_max_jitter_ms¶
The maximum WAN to LAN jitter in milliseconds
Type : integer
wan_to_lan_max_percent_loss¶
The maximum WAN to LAN loss, in percent
Type : number
wan_to_lan_min_bandwidth¶
The minimum WAN to LAN bandwidth for all packet types
Type : number
wan_to_lan_min_jitter_ms¶
The minimum WAN to LAN jitter in milliseconds
Type : integer
wan_to_lan_min_percent_loss¶
The minimum WAN to LAN loss, in percent
Type : number
wan_to_lan_mismatched_bandwidth¶
The WAN to LAN bandwidth not matching an MPLS Queue
Type : number
wan_to_lan_mismtached_packets¶
The WAN to LAN packets not matching an MPLS Queue
Type : integer
wan_to_lan_packets¶
The WAN to LAN packets for all packet types
Type : integer
wan_to_lan_packets_loss¶
The WAN to LAN packets lost
Type : integer
wan_to_lan_packets_ooo¶
The WAN to LAN packets out-of-order
Type : integer
wan_to_lan_percent_loss¶
The WAN to LAN loss, in percent
Type : number
wan_to_lan_percent_ooo¶
The WAN to LAN out-of-order in percent
Type : number
wan_to_lan_permitted_bandwidth¶
The WAN to LAN permitted bandwidth
Type : number
worst_state¶
The worst state observed during the time period
Type : string