flows¶
Overview¶
This resource provides details about LAN TO WAN and WAN TO LAN flows
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/monitor/
Schemes : HTTP
Tags¶
- flows : Operations related to flows
Paths¶
Get operation for flows¶
GET /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
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | flows_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¶
- flows
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
age¶
How long ago this flow was created in milliseconds
Type : string
app_rule_id¶
ID of the app rule that traffic on this flow is matched
Type : string
application¶
Flow's Application name
Type : string
bytes¶
Number of bytes sent over the life of the flow
Type : string
class_type¶
Type of virtual path class that traffic is using
Type : string
customer_kbps¶
Kilobits per second over period since refresh
Type : string
dest_ip¶
Destination IP Address for packets on this flow
Type : string
dest_port¶
Destination Port for packets on this flow
Type : string
direction¶
Direction for packets on this flow
Type : string
flows_delete_success_schema¶
| Name | Schema |
|---|---|
| flows optional |
flows |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
flows_post_success_schema¶
| Name | Schema |
|---|---|
| flows optional |
flows |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
flows_put_success_schema¶
| Name | Schema |
|---|---|
| flows optional |
flows |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
flows_response_schema¶
Type : < flows_response_schema > array
| Name | Schema |
|---|---|
| age optional |
age |
| app_rule_id optional |
app_rule_id |
| application optional |
application |
| bytes optional |
bytes |
| class_type optional |
class_type |
| customer_kbps optional |
customer_kbps |
| dest_ip optional |
dest_ip |
| dest_port optional |
dest_port |
| direction optional |
direction |
| hdr_compression_bytes optional |
hdr_compression_bytes |
| hitcount optional |
hitcount |
| ip_dscp optional |
ip_dscp |
| ipp optional |
ipp |
| ipsec_overhead_kbps optional |
ipsec_overhead_kbps |
| lan_gw_ip optional |
lan_gw_ip |
| packets optional |
packets |
| path optional |
path |
| pps optional |
pps |
| rule_id optional |
rule_id |
| service_name optional |
service_name |
| service_type optional |
service_type |
| src_ip optional |
src_ip |
| src_port optional |
src_port |
| transmission_type optional |
transmission_type |
| virtual_path_overhead_kbps optional |
virtual_path_overhead_kbps |
| vpathclass optional |
vpathclass |
hdr_compression_bytes¶
Number of saved bytes to header compression
Type : string
hitcount¶
The Number of times this flow has been searched for and found
Type : string
ip_dscp¶
IP DSCP tag setting for packets on this flow
Type : string
ipp¶
IP Protocol number for packets on this flow
Type : string
ipsec_overhead_kbps¶
Kilobits per second over period since refresh
Type : string
lan_gw_ip¶
IP Address for LAN Gateway
Type : string
packets¶
Number of packets sent over the life of the flow
Type : string
path¶
Path that the traffic is currently using
Type : string
pps¶
Packets per second over period since refresh
Type : string
rule_id¶
ID of the rule that traffic on this flow is matched
Type : string
service_name¶
Flow Service Name
Type : string
service_type¶
Flow Service Type
Type : string
src_ip¶
Source IP Address for packets on this flow
Type : string
src_port¶
Source Port for packets on this flow
Type : string
transmission_type¶
The Transmission Type that the traffic is currently using
Type : string
virtual_path_overhead_kbps¶
Kilobits per second over period since refresh
Type : string
vpathclass¶
ID of virtual path class that traffic is using
Type : string