Create Wifi Broadcast

Create a new 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

siteId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

type*string

name*string

network?Wifi network reference

enabled*boolean

securityConfiguration*

broadcastingDeviceFilter?Broadcasting device filter

Defines the custom scope of devices that will broadcast this WiFi network. If null, the WiFi network will be broadcast by all Access Point capable devices.

mdnsProxyConfiguration?mDNS filtering configuration

multicastFilteringPolicy?Multicast filtering policy

multicastToUnicastConversionEnabled*boolean

clientIsolationEnabled*boolean

hideName*boolean

uapsdEnabled*boolean

Indicates whether Unscheduled Automatic Power Save Delivery (U-APSD) is enabled

channel2gLockedTo6*boolean

Locks 2.4GHz radio channel to 6 on all broadcasting devices

dtimPeriod2gLockedTo3*boolean

Locks DTIM period to 3 for 2.4GHz radio

basicDataRateKbpsByFrequencyGHz?

clientFilteringPolicy?

Client connection filtering policy. Allow/restrict access to the WiFi network based on client device MAC addresses.

blackoutScheduleConfiguration?

Response Body

`application/json`

curl -X POST "https://example.com/v1/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/wifi/broadcasts" \  -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"      }    ]  }}