get_firewall_group_details
get_firewall_group_details
Section titled “get_firewall_group_details”Show one firewall group’s full record by _id.
Side effects: None (read-only). Call this before
update_firewall_group to see the current members you are about to
read-modify-write.
Returns the group record with _id, name, group_type, and
group_members, or an error envelope if no group matches.
Example
Section titled “Example”get_firewall_group_details(group_id="65f...")Parameters
Section titled “Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
group_id |
string |
yes | — | The _id from list_firewall_groups. |
controller |
string |
no | “default” | Name of the UniFi controller to target. Defaults to "default". |