Skip to content

get_traffic_route_details

Show one traffic route’s full record by _id.

Side effects: None (read-only). Call this before update_traffic_route or toggle_traffic_route to see the route’s current matching target, next hop, and kill-switch state.

Returns the route record, or an error envelope if no route matches.

get_traffic_route_details(route_id="65f...")
ParameterTypeRequiredDefaultDescription
route_idstringyesThe _id from list_traffic_routes.
controllerstringno”default”Name of the UniFi controller to target. Defaults to "default".