paths¶
Overview¶
API to get reports for 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¶
- paths : Operations related to paths
Paths¶
Get operation for paths¶
GET /paths
Description¶
Use this operation to get a report for paths. The response payload also contains the meta_data block.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | 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¶
- paths
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
from_external_source_port¶
The external source UDP port, as observed by remote sites
Type : integer
from_site_name¶
From site name
Type : string
from_source_port¶
The configured source UDP port
Type : integer
from_wanlink_name¶
From wanlink name
Type : string
lan_to_wan_bad_time¶
The total time in the selected time period that the service was bad, in seconds
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_congestion¶
Congestion detected due to increased, unexpected delay in packet flow in the WAN
Type : string
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_data_coverage¶
The amount, in percent of the selected time period for which there is data
Type : number
lan_to_wan_dead_peer_time¶
The total time in the selected time period that the service was dead because notified by peer, in seconds
Type : string
lan_to_wan_down_time¶
The total time in the selected time period that the service was unusable, in seconds
Type : string
lan_to_wan_good_time¶
The total time in the selected time period that the service was good, in seconds
Type : string
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¶
LAN to WAN packets for all packet types
Type : integer
lan_to_wan_percent_bad_peer_time¶
The time, in percent that the service was bad because notified by peer
Type : string
lan_to_wan_percent_bad_silence_time¶
The time, in percent that the service was bad because silence time exceeded threshold
Type : string
lan_to_wan_percent_bad_time¶
The time, in percent that the service was bad
Type : string
lan_to_wan_percent_dead_peer_time¶
The time, in percent that the service was dead because notified by peer
Type : string
lan_to_wan_percent_dead_silence_time¶
The time, in percent that the service was dead because silence time exceeded threshold
Type : string
lan_to_wan_percent_down_time¶
The time, in percent that the service was unusable
Type : string
lan_to_wan_percent_good_time¶
The time, in percent that the service was good
Type : string
lan_to_wan_percent_up_time¶
The time, in percent that the service was usable
Type : string
lan_to_wan_realtime_bandwidth¶
The LAN to WAN real-time bandwidth
Type : number
lan_to_wan_realtime_packets¶
The LAN to WAN real-time packets
Type : integer
lan_to_wan_state_bad_peer_time¶
The total time in the selected time period that the service was bad because notified by peer, in seconds
Type : string
lan_to_wan_state_bad_silence_time¶
The total time in the selected time period that the service was bad because silence time exceeded threshold, in seconds
Type : string
lan_to_wan_state_dead_silence_time¶
The total time in the selected time period that the service was dead because silence time exceeded threshold, in seconds
Type : string
lan_to_wan_up_time¶
The total time in the selected time period that the service was usable, in seconds
Type : string
lan_to_wan_worst_state¶
The worst LAN to WAN state observed during the time period
Type : string
lan_to_wan_worst_state_reason¶
The reason for the worst state observed during the time period
Type : string
maximum_transmission_unit¶
The maximum transmission unit, in bytes
Type : integer
path_name¶
The path name
Type : string
paths_delete_success_schema¶
| Name | Schema |
|---|---|
| paths optional |
paths |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
paths_post_success_schema¶
| Name | Schema |
|---|---|
| paths optional |
paths |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
paths_put_success_schema¶
| Name | Schema |
|---|---|
| paths optional |
paths |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
paths_response_schema¶
Type : < paths_response_schema > array
| Name | Schema |
|---|---|
| from_external_source_port optional |
from_external_source_port |
| from_site_name optional |
from_site_name |
| from_source_port optional |
from_source_port |
| from_wanlink_name optional |
from_wanlink_name |
| lan_to_wan_bad_time optional |
lan_to_wan_bad_time |
| 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_congestion optional |
lan_to_wan_congestion |
| 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_data_coverage optional |
lan_to_wan_data_coverage |
| lan_to_wan_dead_peer_time optional |
lan_to_wan_dead_peer_time |
| lan_to_wan_down_time optional |
lan_to_wan_down_time |
| lan_to_wan_good_time optional |
lan_to_wan_good_time |
| 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_percent_bad_peer_time optional |
lan_to_wan_percent_bad_peer_time |
| lan_to_wan_percent_bad_silence_time optional |
lan_to_wan_percent_bad_silence_time |
| lan_to_wan_percent_bad_time optional |
lan_to_wan_percent_bad_time |
| lan_to_wan_percent_dead_peer_time optional |
lan_to_wan_percent_dead_peer_time |
| lan_to_wan_percent_dead_silence_time optional |
lan_to_wan_percent_dead_silence_time |
| lan_to_wan_percent_down_time optional |
lan_to_wan_percent_down_time |
| lan_to_wan_percent_good_time optional |
lan_to_wan_percent_good_time |
| lan_to_wan_percent_up_time optional |
lan_to_wan_percent_up_time |
| lan_to_wan_realtime_bandwidth optional |
lan_to_wan_realtime_bandwidth |
| lan_to_wan_realtime_packets optional |
lan_to_wan_realtime_packets |
| lan_to_wan_state_bad_peer_time optional |
lan_to_wan_state_bad_peer_time |
| lan_to_wan_state_bad_silence_time optional |
lan_to_wan_state_bad_silence_time |
| lan_to_wan_state_dead_silence_time optional |
lan_to_wan_state_dead_silence_time |
| lan_to_wan_up_time optional |
lan_to_wan_up_time |
| lan_to_wan_worst_state optional |
lan_to_wan_worst_state |
| lan_to_wan_worst_state_reason optional |
lan_to_wan_worst_state_reason |
| maximum_transmission_unit optional |
maximum_transmission_unit |
| path_name optional |
path_name |
| region_name optional |
region_name |
| to_destination_port optional |
to_destination_port |
| to_external_destination_port optional |
to_external_destination_port |
| to_site_name optional |
to_site_name |
| to_wanlink_name optional |
to_wanlink_name |
| wan_to_lan_bad_loss_time optional |
wan_to_lan_bad_loss_time |
| wan_to_lan_bad_silence_time optional |
wan_to_lan_bad_silence_time |
| wan_to_lan_bad_time optional |
wan_to_lan_bad_time |
| 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 optional |
wan_to_lan_congestion |
| wan_to_lan_data_coverage optional |
wan_to_lan_data_coverage |
| wan_to_lan_down_time optional |
wan_to_lan_down_time |
| wan_to_lan_good_time optional |
wan_to_lan_good_time |
| wan_to_lan_jitter_ms optional |
wan_to_lan_jitter_ms |
| wan_to_lan_max_bandwidth optional |
wan_to_lan_max_bandwidth |
| 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_mismatched_packets optional |
wan_to_lan_mismatched_packets |
| wan_to_lan_packets optional |
wan_to_lan_packets |
| wan_to_lan_packets_lost optional |
wan_to_lan_packets_lost |
| wan_to_lan_packets_ooo optional |
wan_to_lan_packets_ooo |
| wan_to_lan_percent_bad_loss_time optional |
wan_to_lan_percent_bad_loss_time |
| wan_to_lan_percent_bad_silence_time optional |
wan_to_lan_percent_bad_silence_time |
| wan_to_lan_percent_bad_time optional |
wan_to_lan_percent_bad_time |
| wan_to_lan_percent_dead_silence_time optional |
wan_to_lan_percent_dead_silence_time |
| wan_to_lan_percent_down_time optional |
wan_to_lan_percent_down_time |
| wan_to_lan_percent_good_time optional |
wan_to_lan_percent_good_time |
| 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_percent_up_time optional |
wan_to_lan_percent_up_time |
| wan_to_lan_state_dead_silence_time optional |
wan_to_lan_state_dead_silence_time |
| wan_to_lan_up_time optional |
wan_to_lan_up_time |
| wan_to_lan_worst_state optional |
wan_to_lan_worst_state |
| wan_to_lan_worst_state_reason optional |
wan_to_lan_worst_state_reason |
region_name¶
The region name
Type : string
to_destination_port¶
The configured Destination UDP port
Type : integer
to_external_destination_port¶
The external destination UDP port, as observed by remote sites
Type : integer
to_site_name¶
To site name
Type : string
to_wanlink_name¶
To wanlink name
Type : string
wan_to_lan_bad_loss_time¶
The total time in the selected time period that the service was bad because packet loss exceeded threshold, in seconds
Type : string
wan_to_lan_bad_silence_time¶
The total time in the selected time period that the service was bad because silence time exceeded threshold, in seconds
Type : string
wan_to_lan_bad_time¶
The total time in the selected time period that the service was bad, in seconds
Type : string
wan_to_lan_bandwidth¶
WAN to LAN bandwidth for all packet types
Type : number
wan_to_lan_best_one_way_time_latency_ms¶
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¶
Congestion detected due to increased, unexpected delay in packet flow in the WAN
Type : string
wan_to_lan_data_coverage¶
The amount, in percent of the selected time period for which there is data
Type : number
wan_to_lan_down_time¶
The total time in the selected time period that the service was unusable, in seconds
Type : string
wan_to_lan_good_time¶
The total time in the selected time period that the service was good, in seconds
Type : string
wan_to_lan_jitter_ms¶
WAN to LAN jitter in milliseconds
Type : integer
wan_to_lan_max_bandwidth¶
The maximum WAN to LAN bandwidth for all packet types
Type : number
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¶
WAN to LAN bandwidth not matching an MPLS Queue
Type : number
wan_to_lan_mismatched_packets¶
WAN to LAN packets not matching an MPLS Queue
Type : integer
wan_to_lan_packets¶
WAN to LAN packets for all packet types
Type : string
wan_to_lan_packets_lost¶
WAN to LAN packets lost
Type : integer
wan_to_lan_packets_ooo¶
WAN to LAN packets out-of-order
Type : integer
wan_to_lan_percent_bad_loss_time¶
The time, in percent that the service was bad because packet loss exceeded threshold
Type : string
wan_to_lan_percent_bad_silence_time¶
The time, in percent that the service was bad because silence time exceeded threshold
Type : string
wan_to_lan_percent_bad_time¶
The time, in percent that the service was bad
Type : string
wan_to_lan_percent_dead_silence_time¶
The time, in percent that the service was dead because silence time exceeded threshold
Type : string
wan_to_lan_percent_down_time¶
The time, in percent that the service was unusable
Type : string
wan_to_lan_percent_good_time¶
The time, in percent that the service was good
Type : string
wan_to_lan_percent_loss¶
WAN to LAN loss, in percent
Type : number
wan_to_lan_percent_ooo¶
WAN to LAN out-of-order, in percent
Type : number
wan_to_lan_percent_up_time¶
The time, in percent that the service was usable
Type : string
wan_to_lan_state_dead_silence_time¶
The total time in the selected time period that the service was dead because silence time exceeded threshold, in seconds
Type : string
wan_to_lan_up_time¶
The total time in the selected time period that the service was usable, in seconds
Type : string
wan_to_lan_worst_state¶
The worst WAN to LAN state observed during the time period
Type : string
wan_to_lan_worst_state_reason¶
The reason for the worst state observed during the time period
Type : string