Get Flow Information (v3.7)

POST 
/sdwan/v3.7/api/monitor/flows

List all the flow information.

Request

application/json

Body

Filter for flows

debug_level stringrequired

Possible values: [summary, tcp-flags, traffic, all]

The values of the debug levels.

end_time daterequired

The end time to get the flows information.

filter FlowsFilterrequired

Filters according to the specifications.

app string[]required

App

element string[]required

Element

flow FlowTupplerequired

Flow

destination_ip string[]required

Destination Ip

destination_port integer[]required

Destination Port

protocol integerrequired

Protocol

source_ip string[]required

Source Ip

source_port integer[]required

Source Port

flow_type stringrequired

Possible values: [local, wan, all]

Flow Type

path string[]required

Path

path_type string[]required

Possible values: [public_direct, public_vpn, private_direct, private_vpn, unknown, servicelink]

Path Type

security_policy_destination_zone string[]required

Security Policy Destination Zone

security_policy_rule string[]required

Security Policy Rule

security_policy_rule_action stringrequired

Possible values: [allow, deny, reject]

Security Policy Rule Action

security_policy_source_zone string[]required

Security Policy Source Zone

site string[]required

Site

waninterface string[]required

Waninterface

max_datapoints integerrequired

The max data points.

name stringrequired

The description of the flow. Maz size = 128.

start_time daterequired

The start time to get the flow information.

Responses

200

Successful Operation

application/json

Schema

Schema

flows Flowsrequired

Flows

debug_level stringrequired

Debug Level

end_time stringrequired

End Time

items FlowDetails[]required

Items

Array [

app_id stringrequired

App Id

average_ntt floatrequired

Average Ntt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

average_pg floatrequired

Average Pg: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

average_rtt floatrequired

Average Rtt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

average_srt floatrequired

Average Srt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

average_udp_trt floatrequired

Average Udp Trt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

avg_jitter_c2s floatrequired

Avg Jitter C2s: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

avg_jitter_s2c floatrequired

Avg Jitter S2c: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

avg_mos_c2s floatrequired

Avg Mos C2s: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

avg_mos_s2c floatrequired

Avg Mos S2c: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

avg_packet_loss_c2s floatrequired

Avg Packet Loss C2s: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

avg_packet_loss_s2c floatrequired

Avg Packet Loss S2c: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

bytes_c2s int64required

Bytes C2s

bytes_s2c int64required

Bytes S2c

codec_c2s int64[]required

Codec C2s: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

codec_s2c int64[]required

Codec S2c: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

destination_ip stringrequired

Destination Ip

destination_lan_network_id stringrequired

Destination Lan Network Id

destination_lan_vlan_id integerrequired

Destination Lan Vlan Id

destination_port integerrequired

Destination Port

element_id stringrequired

Element Id

fc_app_id stringrequired

Fc App Id

fin_c2s int64required

Fin C2s

fin_s2c int64required

Fin S2c

flow_action stringrequired

Flow Action

flow_decision_metadata_list FlowDecisionMetadata[]required

Flow Decision Metadata List

Array [

available_wan_networks string[]required

Available Wan Networks: JsonAlias(value = [bw_paths]) JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

chosen_wan_path stringrequired

Chosen Wan Path: JsonAlias(value = [path_id])

flow_decision_bitmap int64[]required

Flow Decision Bitmap: JsonAlias(value = [bitmap]) JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

flow_decision_time int64required

Flow Decision Time: JsonAlias(value = [time])

policy_allowed_wan_paths string[]required

Policy Allowed Wan Paths: JsonAlias(value = [policy_paths]) JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

predictive_wan_network_normalized_load string[]required

Predictive Wan Network Normalized Load: JsonAlias(value = [bw_values]) JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

preferred_wan_path stringrequired

Preferred Wan Path: JsonAlias(value = [pref_wan_path]) JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

sla_filtered_state_up_policy_allowed_wan_paths string[]required

Sla Filtered State Up Policy Allowed Wan Paths: JsonAlias(value = [policy_l2l3_sla_paths]) JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

state_up_policy_allowed_wan_paths string[]required

State Up Policy Allowed Wan Paths: JsonAlias(value = [policy_l2l3_paths]) JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

]

flow_end_time_ms int64required

Flow End Time Ms

flow_start_time_ms int64required

Flow Start Time Ms

incomplete_trans int64required

Incomplete Trans: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

init_success booleanrequired

Init Success: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

is_local_traffic booleanrequired

Is Local Traffic

is_sec_policy_present booleanrequired

Is Sec Policy Present

is_v6 booleanrequired

Is V6

lan_dscp_lan_to_wan integer[]required

Lan Dscp Lan To Wan: JsonDeserialize(as = classOf[Void], builder = classOf[Void], contentAs = classOf[Void], contentConverter = classOf[Converter$None], contentUsing = classOf[JsonDeserializer$None], converter = classOf[Converter$None], keyAs = classOf[Void], keyUsing = classOf[KeyDeserializer$None], using = classOf[CustomGetSetPositionsDeserializer])

lan_dscp_wan_to_lan integer[]required

Lan Dscp Wan To Lan: JsonDeserialize(as = classOf[Void], builder = classOf[Void], contentAs = classOf[Void], contentConverter = classOf[Converter$None], contentUsing = classOf[JsonDeserializer$None], converter = classOf[Converter$None], keyAs = classOf[Void], keyUsing = classOf[KeyDeserializer$None], using = classOf[CustomGetSetPositionsDeserializer])

lan_origination_id stringrequired

Lan Origination Id

lan_termination_id stringrequired

Lan Termination Id

lan_to_wan booleanrequired

Lan To Wan

max_jitter_c2s floatrequired

Max Jitter C2s: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

max_jitter_s2c floatrequired

Max Jitter S2c: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

max_mos_c2s floatrequired

Max Mos C2s: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

max_mos_s2c floatrequired

Max Mos S2c: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

max_ntt floatrequired

Max Ntt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

max_packet_loss_c2s floatrequired

Max Packet Loss C2s: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

max_packet_loss_s2c floatrequired

Max Packet Loss S2c: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

max_pg floatrequired

Max Pg: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

max_rtt floatrequired

Max Rtt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

max_srt floatrequired

Max Srt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

max_udp_trt floatrequired

Max Udp Trt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

media_type stringrequired

Media Type: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

min_mos_c2s floatrequired

Min Mos C2s: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

min_mos_s2c floatrequired

Min Mos S2c: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

min_ntt floatrequired

Min Ntt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

min_pg floatrequired

Min Pg: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

min_rtt floatrequired

Min Rtt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

min_srt floatrequired

Min Srt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

min_udp_trt floatrequired

Min Udp Trt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

network_policy_dst_prefix_id stringrequired

Network Policy Dst Prefix Id

network_policy_id stringrequired

Network Policy Id

network_policy_nctx_id stringrequired

Network Policy Nctx Id

network_policy_set_id stringrequired

Network Policy Set Id

network_policy_src_prefix_id stringrequired

Network Policy Src Prefix Id

network_policy_stack_id stringrequired

Network Policy Stack Id

new_flow booleanrequired

New Flow

ooo_pkts_c2s int64required

Ooo Pkts C2s

ooo_pkts_s2c int64required

Ooo Pkts S2c

packets_c2s int64required

Packets C2s

packets_s2c int64required

Packets S2c

path_id stringrequired

Path Id

path_type stringrequired

Path Type

policy_id stringrequired

Policy Id

priority_class integerrequired

Priority Class: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

priority_policy_default_rule_mapping_incoming_dscp int64required

Priority Policy Default Rule Mapping Incoming Dscp

priority_policy_dst_prefix_id stringrequired

Priority Policy Dst Prefix Id

priority_policy_id stringrequired

Priority Policy Id

priority_policy_nctx_id stringrequired

Priority Policy Nctx Id

priority_policy_remark_dscp int64required

Priority Policy Remark Dscp

priority_policy_set_id stringrequired

Priority Policy Set Id

priority_policy_src_prefix_id stringrequired

Priority Policy Src Prefix Id

priority_policy_stack_id stringrequired

Priority Policy Stack Id

protocol integerrequired

Protocol

reset_c2s int64required

Reset C2s

reset_s2c int64required

Reset S2c

retransmit_bytes_c2s int64required

Retransmit Bytes C2s

retransmit_bytes_s2c int64required

Retransmit Bytes S2c

retransmit_pkts_c2s int64required

Retransmit Pkts C2s

retransmit_pkts_s2c int64required

Retransmit Pkts S2c

sack_pkts_c2s int64required

Sack Pkts C2s

sack_pkts_s2c int64required

Sack Pkts S2c

sec_fc_app_id string[]required

Sec Fc App Id

security_policy_rules SecurityPolicyRules[]required

Security Policy Rules: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = NON_EMPTY, valueFilter = classOf[Void])

Array [

bytes_c2s int64required

bytes_s2c int64required

packets_c2s int64required

packets_s2c int64required

security_destination_zone_id stringrequired

Security Destination Zone Id: JsonAlias(value = [dst_zone_id])

security_policy_rule_action stringrequired

Security Policy Rule Action: JsonAlias(value = [action])

security_policy_rule_id stringrequired

Security Policy Rule Id: JsonAlias(value = [rule_id])

security_source_zone_id stringrequired

Security Source Zone Id: JsonAlias(value = [src_zone_id])

time int64required

Time

]

service_endpoint_id stringrequired

Service Endpoint Id: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

source_ip stringrequired

Source Ip

source_lan_network_id stringrequired

Source Lan Network Id

source_lan_vlan_id integerrequired

Source Lan Vlan Id

source_port integerrequired

Source Port

success_transactions int64required

Success Transactions: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

syn_c2s int64required

Syn C2s

syn_s2c int64required

Syn S2c

traffic_type stringrequired

Traffic Type: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

unknown_domain stringrequired

Unknown Domain

unknown_reason stringrequired

Unknown Reason

user_name stringrequired

User Name

vlan_id integerrequired

Vlan Id

wan_path_change_reason stringrequired

Wan Path Change Reason: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

waninterface_id stringrequired

Waninterface Id

win_scaler_c2s int64required

Win Scaler C2s

win_scaler_s2c int64required

Win Scaler S2c

win_size_c2s int64required

Win Size C2s

win_size_s2c int64required

Win Size S2c

]

start_time stringrequired

Start Time

Example (from schema)

{
  "flows": {
    "debug_level": "string",
    "end_time": "string",
    "items": [
      {
        "app_id": "string",
        "average_ntt": 0,
        "average_pg": 0,
        "average_rtt": 0,
        "average_srt": 0,
        "average_udp_trt": 0,
        "avg_jitter_c2s": 0,
        "avg_jitter_s2c": 0,
        "avg_mos_c2s": 0,
        "avg_mos_s2c": 0,
        "avg_packet_loss_c2s": 0,
        "avg_packet_loss_s2c": 0,
        "bytes_c2s": 0,
        "bytes_s2c": 0,
        "codec_c2s": [
          0
        ],
        "codec_s2c": [
          0
        ],
        "destination_ip": "string",
        "destination_lan_network_id": "string",
        "destination_lan_vlan_id": 0,
        "destination_port": 0,
        "element_id": "string",
        "fc_app_id": "string",
        "fin_c2s": 0,
        "fin_s2c": 0,
        "flow_action": "string",
        "flow_decision_metadata_list": [
          {
            "available_wan_networks": [
              "string"
            ],
            "chosen_wan_path": "string",
            "flow_decision_bitmap": [
              0
            ],
            "flow_decision_time": 0,
            "policy_allowed_wan_paths": [
              "string"
            ],
            "predictive_wan_network_normalized_load": [
              "string"
            ],
            "preferred_wan_path": "string",
            "sla_filtered_state_up_policy_allowed_wan_paths": [
              "string"
            ],
            "state_up_policy_allowed_wan_paths": [
              "string"
            ]
          }
        ],
        "flow_end_time_ms": 0,
        "flow_start_time_ms": 0,
        "incomplete_trans": 0,
        "init_success": true,
        "is_local_traffic": true,
        "is_sec_policy_present": true,
        "is_v6": true,
        "lan_dscp_lan_to_wan": [
          0
        ],
        "lan_dscp_wan_to_lan": [
          0
        ],
        "lan_origination_id": "string",
        "lan_termination_id": "string",
        "lan_to_wan": true,
        "max_jitter_c2s": 0,
        "max_jitter_s2c": 0,
        "max_mos_c2s": 0,
        "max_mos_s2c": 0,
        "max_ntt": 0,
        "max_packet_loss_c2s": 0,
        "max_packet_loss_s2c": 0,
        "max_pg": 0,
        "max_rtt": 0,
        "max_srt": 0,
        "max_udp_trt": 0,
        "media_type": "string",
        "min_mos_c2s": 0,
        "min_mos_s2c": 0,
        "min_ntt": 0,
        "min_pg": 0,
        "min_rtt": 0,
        "min_srt": 0,
        "min_udp_trt": 0,
        "network_policy_dst_prefix_id": "string",
        "network_policy_id": "string",
        "network_policy_nctx_id": "string",
        "network_policy_set_id": "string",
        "network_policy_src_prefix_id": "string",
        "network_policy_stack_id": "string",
        "new_flow": true,
        "ooo_pkts_c2s": 0,
        "ooo_pkts_s2c": 0,
        "packets_c2s": 0,
        "packets_s2c": 0,
        "path_id": "string",
        "path_type": "string",
        "policy_id": "string",
        "priority_class": 0,
        "priority_policy_default_rule_mapping_incoming_dscp": 0,
        "priority_policy_dst_prefix_id": "string",
        "priority_policy_id": "string",
        "priority_policy_nctx_id": "string",
        "priority_policy_remark_dscp": 0,
        "priority_policy_set_id": "string",
        "priority_policy_src_prefix_id": "string",
        "priority_policy_stack_id": "string",
        "protocol": 0,
        "reset_c2s": 0,
        "reset_s2c": 0,
        "retransmit_bytes_c2s": 0,
        "retransmit_bytes_s2c": 0,
        "retransmit_pkts_c2s": 0,
        "retransmit_pkts_s2c": 0,
        "sack_pkts_c2s": 0,
        "sack_pkts_s2c": 0,
        "sec_fc_app_id": [
          "string"
        ],
        "security_policy_rules": [
          {
            "bytes_c2s": 0,
            "bytes_s2c": 0,
            "packets_c2s": 0,
            "packets_s2c": 0,
            "security_destination_zone_id": "string",
            "security_policy_rule_action": "string",
            "security_policy_rule_id": "string",
            "security_source_zone_id": "string",
            "time": 0
          }
        ],
        "service_endpoint_id": "string",
        "source_ip": "string",
        "source_lan_network_id": "string",
        "source_lan_vlan_id": 0,
        "source_port": 0,
        "success_transactions": 0,
        "syn_c2s": 0,
        "syn_s2c": 0,
        "traffic_type": "string",
        "unknown_domain": "string",
        "unknown_reason": "string",
        "user_name": "string",
        "vlan_id": 0,
        "wan_path_change_reason": "string",
        "waninterface_id": "string",
        "win_scaler_c2s": 0,
        "win_scaler_s2c": 0,
        "win_size_c2s": 0,
        "win_size_s2c": 0
      }
    ],
    "start_time": "string"
  }
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
message string
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "EMPTY_REQ_BODY"
      },
      {
        "code": "SCHEMA_MISMATCH"
      },
      {
        "code": "START_TIME_GREATER_THAN_END_TIME"
      },
      {
        "code": "INVALID_REQUEST_ERROR_0001"
      },
      {
        "code": "EMPTY_FILTER"
      },
      {
        "code": "PATH_AND_PATH_TYPE_NOT_SUPPORTED"
      },
      {
        "code": "SITE_WITH_PATH_MISSING"
      },
      {
        "code": "SITE_WITH_WANINTERFACE_MISSING"
      },
      {
        "code": "SITE_WITH_ELEMENT_MISSING"
      },
      {
        "code": "SITE_WITH_FLOW_TUPLE_MISSING"
      },
      {
        "code": "INVALID_IP"
      },
      {
        "code": "INVALID_FLOW_TYPE"
      }
    ]
  }
}

500

Internal Server Error

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
message string
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Loading...