Skip to content

list_ap_groups

List access-point groups configured on the controller.

Side effects: None (read-only).

Returns one record per AP group with _id, name, attr_hidden_id (the built-in “default” group carries "default" here), device_macs, and site_id.

Used by create_wlan to auto-resolve the default AP group when no explicit ap_group_ids is supplied. Call this directly to inspect which groups exist before creating per-AP-group WLANs.

list_ap_groups(controller="default")
ParameterTypeRequiredDefaultDescription
controllerstringno”default”Name of the UniFi controller to target. Defaults to "default".