flows
flows
Monitoring for This resource provides details about LAN TO WAN and WAN TO LAN flows resource.
Read/write properties
Read only properties
bytes <String>
Number of bytes sent over the life of the flow.
dest_ip <String>
Destination IP Address for packets on this flow.
packets <String>
Number of packets sent over the life of the flow.
src_ip <String>
Source IP Address for packets on this flow.
age <String>
How long ago this flow was created in milliseconds.
transmission_type <String>
The Transmission Type that the traffic is currently using.
ip_dscp <String>
IP DSCP tag setting for packets on this flow.
direction <String>
Direction for packets on this flow.
service_name <String>
Flow Service Name.
class_type <String>
Type of virtual path class that traffic is using.
dest_port <String>
Destination Port for packets on this flow.
ipp <String>
IP Protocol number for packets on this flow.
vpathclass <String>
ID of virtual path class that traffic is using.
app_rule_id <String>
ID of the app rule that traffic on this flow is matched.
service_type <String>
Flow Service Type.
src_port <String>
Source Port for packets on this flow.
hitcount <String>
The Number of times this flow has been searched for and found.
pps <String>
Packets per second over period since refresh.
customer_kbps <String>
Kilobits per second over period since refresh.
path <String>
Path that the traffic is currently using.
rule_id <String>
ID of the rule that traffic on this flow is matched.
virtual_path_overhead_kbps <String>
Kilobits per second over period since refresh.
ipsec_overhead_kbps <String>
Kilobits per second over period since refresh.
hdr_compression_bytes <String>
Number of saved bytes to header compression.
lan_gw_ip <String>
IP Address for LAN Gateway.
Operations
[get (all)]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/monitor/flows
Description: Use this operation to get the LAN TO WAN and WAN TO LAN flows details. Filters are supported for this API, max_stats filter is available as an additional option to filter the flows count(50/100/1000). Refer Getting Started Guide where filtering is explained via example of flow summary with max stats filter for monitoring API. Pagination is not supported for this API
HTTP Method: GET
Response Payload: JSON
{"flows":[{ "bytes":<String_value>
, "dest_ip":<String_value> , "packets":<String_value> , "src_ip":<String_value> , "age":<String_value> , "transmission_type":<String_value> , "ip_dscp":<String_value> , "direction":<String_value> , "service_name":<String_value> , "class_type":<String_value> , "dest_port":<String_value> , "ipp":<String_value> , "vpathclass":<String_value> , "app_rule_id":<String_value> , "service_type":<String_value> , "src_port":<String_value> , "hitcount":<String_value> , "pps":<String_value> , "customer_kbps":<String_value> , "path":<String_value> , "rule_id":<String_value> , "virtual_path_overhead_kbps":<String_value> , "ipsec_overhead_kbps":<String_value> , "hdr_compression_bytes":<String_value> , "lan_gw_ip":<String_value> }]}