get_traffic_rule_details
get_traffic_rule_details
Section titled “get_traffic_rule_details”Show one traffic rule’s full record by _id.
Side effects: None (read-only). Call this before
update_traffic_rule or toggle_traffic_rule to see the rule’s
current matching target and action.
Returns the rule record, or an error envelope if no rule matches.
Example
Section titled “Example”get_traffic_rule_details(rule_id="65f...")Parameters
Section titled “Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
rule_id |
string |
yes | — | The _id from list_traffic_rules. |
controller |
string |
no | “default” | Name of the UniFi controller to target. Defaults to "default". |