Skip to content

get_route_details

Show one static route’s full record by _id.

Side effects: None (read-only). Call this before update_route to see the current destination, next hop, and distance.

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

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