update_wlan

update_wlan

Patch fields on an existing WiFi SSID.

Side effects:

• Modifies the named WLAN in place. Only fields supplied in updates change; everything else is preserved.
• Changes to security, wpa_mode, or x_passphrase may disconnect connected clients until they re-authenticate.
• Passphrases passed via x_passphrase are redacted in the response.
• Mutates controller state. Use dry_run=True to preview the change without applying.

Example

update_wlan(wlan_id="65f...", updates={"enabled": False})

Parameters

Parameter	Type	Required	Default	Description
wlan_id	string	yes	—	The _id from list_wlans.
updates	object	yes	—	Partial WLAN record. Common keys: name, enabled, x_passphrase, wpa_mode, hide_ssid, wlan_band, is_guest.
controller	string	no	”default”	Name of the UniFi controller to target. Defaults to "default".
dry_run	boolean	no	false	Preview the change without applying it. Returns the predicted change set.