Returns active, inactive, or both types of flows on the appliance based on the query parameters supplied

get

http://127.0.0.1:8080/flow

Flows can be more specifically filtered by the available query parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

string

required

Appliance ID

ip1

string

First IP endpoint

mask1

int32

Mask for ip1

port1

int32

≥ 0

Port of first IP endpoint

ip2

string

Second IP endpoint

mask2

int32

Mask for ip2

port2

int32

≥ 0

Port of second IP endpoint

ipEitherFlag

boolean

Defaults to true

Enable directionality for IP. If true, ip1 will be treated as the source IP, and ip2 will be treated as the destination IP

portEitherFlag

boolean

Defaults to true

Enable directionality for port. If true, port1 will be treated as the source port, and port2 will be treated as the destination port

vrf1

string

VRF ID for ip1. Values: "0" (default), "vrf_id"

vrf2

string

VRF ID for ip2. Values: "0" (default), "vrf_id"

vrfEither

string

VRF ID for flows sourced from vrfEither or destined to vrfEither. Values: "any", "0" (default), "vrf_id"

application

string

enum

Application specific flows. Drop-down only shows built-in apps and not user-defined apps

applicationGroup

string

enum

Application groups. Drop-down only shows a small subset of application groups

protocol

string

enum

Application protocol

vlan

int32

≥ 0

Virtual LAN ID

dscp

string

Defaults to any

DSCP marking

overlays

string

Overlay ID. Multiple values must be separated with "|". E.g. "1|2"

transport

string

Transport type. Accepted values: "fabric", "underlay", "breakout". Multiple values must be separated with "|". E.g. "fabric|underlay". Note: Fabric refers to SD-WAN.

services

array of strings

Service name. Third party services should be formatted with an asterisk symbol at the end in order to filter by prefix instead of finding a complete match. Multiple services must be separated with "|". E.g. "Zscaler_*|PaloAlto"

services

zone1

string

Flows to zone1. Values: "any", "0" (default), "zone_id"

zone2

string

Flows from zone2. Values: "any", "0" (default), "zone_id"

zoneEither

string

Flows either to zoneEither or from zoneEither. Values: "any", "0" (default), "zone_id"

filter

string

enum

Defaults to all

Flow categories

edgeHA

boolean

enum

Defaults to false

Edge HA flows. "True" to include, "False" to exclude

Allowed:

builtIn

boolean

enum

Defaults to false

Built-in policy flows. "True" to include, "False" to exclude

Allowed:

uptime

string

enum

Active and ended flow timing. If not specified, it defaults to "anytime" plus "term"

bytes

string

enum

Defaults to total

Bytes transferred

Allowed:

duration

string

Defaults to any

Flows that have lasted less than ("<") or greater than (">") the specified duration (in minutes). Value should be "any" or a number formatted with a "<" or ">" in front of a value between 0 and 18446744073709551615. E.g. ">5000"

maxFlows

integer

enum

required

Defaults to 10000

Maximum number of flows to be shown.

Allowed:

anytimeSlowFlows

string

Slow Flows flag. If this flag is present, it will show slow flows only

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200No response was specified