Unifi

Interact with Unifi API

Actions27

Client Actions
Device Actions
Internet Access Control Actions
- Bandwidth Limits
- Set Access
Network Actions
Site Actions
Sites and Monitoring Actions

Network → Create Network

AI-generated

Summary

Create a new network within a specified Unifi site by configuring its SSID, password, security settings, WPA mode, VLAN enablement, and whether the network is enabled.

Inputs

Site Name (required) — The site identifier where the network will be created, found in the 'name' field of the response from the 'List Sites' operation.
SSID (required) — The name (SSID) of the new network to create.
Password (required) — The password for the network.
Security (required) — The security protocol for the network; options include WPAPSK, WPAEAP, Open, or WEP.
WPA Mode (required) — The WPA mode to use for the network security; options are WPA, WPA2, or WPA3.
Enabled (required) — Whether the network is enabled or disabled.
VLAN Enabled (required) — Indicates if VLAN tagging is enabled for the network.

Output shape

a single JSON object representing the created network's details as returned by the Unifi API

The output includes all properties returned by the API for the newly created network. Errors during creation will throw exceptions with descriptive messages.

Examples

Example 1: Create a WPA2 secured network with WPA-PSK authentication enabled and VLAN disabled.

'Site Name' set to a valid site name; 'SSID' and 'Password' set to desired values; 'Security' set to WPAPSK; 'WPA Mode' set to WPA2; 'Enabled' set to true; 'VLAN Enabled' set to false.

UnifiInstall