get_traffic_route_details
get_traffic_route_details
Section titled “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.
Example
Section titled “Example”get_traffic_route_details(route_id="65f...")Parameters
Section titled “Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
route_id |
string |
yes | — | The _id from list_traffic_routes. |
controller |
string |
no | “default” | Name of the UniFi controller to target. Defaults to "default". |