Skip to content

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.

get_firewall_group_details(group_id="65f...")
ParameterTypeRequiredDefaultDescription
group_idstringyesThe _id from list_firewall_groups.
controllerstringno”default”Name of the UniFi controller to target. Defaults to "default".