set_camera_privacy_mode

set_camera_privacy_mode

Toggle a camera’s privacy mask (lens cover) on or off.

Side effects:

• PATCHes privacyMask.enabled on the camera. When True, the camera stops capturing video; clips are not recorded.
• Mutates controller state. Use dry_run=True to preview the change without applying.

Example

set_camera_privacy_mode(camera_id="65f...", enabled=True)

Parameters

Parameter	Type	Required	Default	Description
camera_id	string	yes	—	Protect camera id.
enabled	boolean	yes	—	True to engage the privacy mask, False to release it.
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.