go-unifi

List Wifi Broadcasts

Retrieve a paginated list of all Wifi Broadcasts on a site. <details> <summary>Filterable properties (click to expand)</summary> |Name|Type|Allowed functions| |-|-|-| |`type`|`STRING`|`eq` `ne` `in` `notIn`| |`id`|`UUID`|`eq` `ne` `in` `notIn`| |`enabled`|`BOOLEAN`|`eq` `ne`| |`name`|`STRING`|`eq` `ne` `in` `notIn` `like`| |`broadcastingFrequenciesGHz`|`SET(DECIMAL)`|`contains` `containsAny` `containsAll` `containsExactly`| |`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`| |`network.type`|`STRING`|`eq` `ne` `in` `notIn` `isNull` `isNotNull`| |`network.networkId`|`UUID`|`eq` `ne` `in` `notIn`| |`securityConfiguration.type`|`STRING`|`eq` `ne` `in` `notIn`| |`broadcastingDeviceFilter.type`|`STRING`|`eq` `ne` `in` `notIn` `isNull` `isNotNull`| |`broadcastingDeviceFilter.deviceIds`|`SET(UUID)`|`contains` `containsAny` `containsAll` `containsExactly`| |`broadcastingDeviceFilter.deviceTagIds`|`SET(UUID)`|`contains` `containsAny` `containsAll` `containsExactly`| |`hotspotConfiguration.type`|`STRING`|`eq` `ne` `in` `notIn`| </details>

GET
/v1/sites/{siteId}/wifi/broadcasts

Retrieve a paginated list of all Wifi Broadcasts on a site.

NameTypeAllowed functions
typeSTRINGeq ne in notIn
idUUIDeq ne in notIn
enabledBOOLEANeq ne
nameSTRINGeq ne in notIn like
broadcastingFrequenciesGHzSET(DECIMAL)contains containsAny containsAll containsExactly
metadata.originSTRINGeq ne in notIn
network.typeSTRINGeq ne in notIn isNull isNotNull
network.networkIdUUIDeq ne in notIn
securityConfiguration.typeSTRINGeq ne in notIn
broadcastingDeviceFilter.typeSTRINGeq ne in notIn isNull isNotNull
broadcastingDeviceFilter.deviceIdsSET(UUID)contains containsAny containsAll containsExactly
broadcastingDeviceFilter.deviceTagIdsSET(UUID)contains containsAny containsAll containsExactly
hotspotConfiguration.typeSTRINGeq ne in notIn
X-Api-Key<token>

UniFi API key. Create one under Control Plane → Admins & Users → your admin → Create API Key (requires controller 9.0.114+).

In: header

Path Parameters

siteId*string

Query Parameters

offset?integer
limit?integer
filter?string

Response Body

application/json

curl -X GET "https://example.com/v1/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/wifi/broadcasts"
{  "offset": 0,  "limit": 25,  "count": 10,  "totalCount": 1000,  "data": [    {      "type": "string",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "enabled": true,      "metadata": {        "origin": "string"      },      "network": {        "type": "string"      },      "securityConfiguration": {        "type": "string"      },      "broadcastingDeviceFilter": {        "type": "string"      }    }  ]}