go-unifi
ReferenceOfficial APIOpenAPI SpecWifi broadcasts

Update Wifi Broadcast

Update an existing Wifi Broadcast on the specified site.

PUT
/v1/sites/{siteId}/wifi/broadcasts/{wifiBroadcastId}

Update an existing Wifi Broadcast on the specified site.

Authorization

ApiKey
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

wifiBroadcastId*string
siteId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/v1/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/wifi/broadcasts/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "type": "string",    "name": "string",    "enabled": true,    "securityConfiguration": {      "type": "string"    },    "multicastToUnicastConversionEnabled": true,    "clientIsolationEnabled": true,    "hideName": true,    "uapsdEnabled": true,    "channel2gLockedTo6": false,    "dtimPeriod2gLockedTo3": false  }'
{  "type": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "metadata": {    "origin": "string"  },  "enabled": true,  "network": {    "type": "string"  },  "securityConfiguration": {    "type": "string",    "radiusConfiguration": null  },  "broadcastingDeviceFilter": {    "type": "string"  },  "mdnsProxyConfiguration": {    "mode": "string"  },  "multicastFilteringPolicy": {    "action": "string"  },  "multicastToUnicastConversionEnabled": true,  "clientIsolationEnabled": true,  "hideName": true,  "uapsdEnabled": true,  "channel2gLockedTo6": true,  "dtimPeriod2gLockedTo3": true,  "basicDataRateKbpsByFrequencyGHz": {    "5": 6000,    "2.4": 2000  },  "clientFilteringPolicy": {    "action": "ALLOW",    "macAddressFilter": []  },  "blackoutScheduleConfiguration": {    "days": [      {        "type": "string",        "day": "SUN"      }    ]  }}

List Wifi Broadcasts GET

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>

Internal API

The Internal (legacy) surface — every resource as Verb-Resource methods on the client, addressed by site name.