Skip to content

list_traffic_routes

List v2 traffic routes (policy-based routing, e.g. VPN-client routes).

Side effects: None (read-only).

Returns one record per route with _id, matching_target, next_hop / network_id (the interface or VPN the matched traffic is sent out), kill_switch_enabled, and enabled. Empty on a gateway with no policy routes configured.

list_traffic_routes(controller="default")
ParameterTypeRequiredDefaultDescription
controllerstringno”default”Name of the UniFi controller to target. Defaults to "default".