API Docs
Powered by

# Flow

# Flow

Name Type Description
ts Number A Unix timestamp that shows the time the flow ended
gid String Unique identifier of the Firewalla box that captured this flow
protocol String Transport protocol of this flow, either tcp or udp
direction String Direction of the flow, inbound for inbound, outbound for outbound, or local for local traffic
block Boolean Whether this is a blocked flow or regular flow. true for blocked flow
blockType String optional Type of blocked flow, either ip or dns, only returned on blocked flows
download Number optional Number of bytes downloaded, only returned on regular flows
upload Number optional Number of bytes uploaded, only returned on regular flows
duration Number optional Duration of this flow in seconds, only return on regular flows
count Number Number of TCP connections or UDP sessions for flow, or block count for blocked flow
device Device Detailed information of the monitoring device involved in this flow
source Host optional Detailed information of the source host involved in this flow
destination Host optional Detailed information of the destination host involved in this flow
region String optional Region of the remote IP, a 2-letter ISO 3166 code
category Category optional Remote host category, based on Firewalla cloud intel
network Network Network that this flow was captured on

# Device

Name Type Description
id DeviceID This device’s unique identifier
ip String Device IP address
name String Device display name

# Network

Name Type Description
id String The network’s unique identifier
name String Name of the network

# Host

Name Type Description
id String If host is a local device, it is DeviceID, otherwise it is remote host domain or ip
name String If host is a local device, it is device display name, otherwise it is remote host domain
ip String IP address of the host.

# Category

Possible Values
ad edu games gamble intel p2p porn private social shopping video vpn

© Copyright 2025. All rights reserved.