UniFi Protect icon

UniFi Protect

Interact with UniFi Protect API

Actions18

Overview

This node operation updates the settings of a specific camera in the UniFi Protect system. It allows users to modify various camera attributes such as the camera's name, recording mode, HDR mode, and status light settings. This operation is useful for managing camera configurations dynamically, for example, changing recording modes based on different surveillance needs or enabling/disabling HDR for better image quality.

Use Case Examples

  1. Updating the name of a camera to better identify its location.
  2. Changing the recording mode from motion detection to always recording for continuous surveillance.
  3. Enabling HDR mode to improve video quality in challenging lighting conditions.
  4. Disabling the status light on a camera to avoid drawing attention.

Properties

Name Meaning
Camera ID The unique identifier (UUID) of the camera to update. This is required to specify which camera's settings will be changed.
Update Fields A collection of fields that can be updated for the camera, including name, recording mode, HDR mode, and status light settings.
Request Options Options to control request behavior such as batching, SSL certificate validation, proxy settings, and request timeout.

Output

JSON

  • id - The unique identifier of the updated camera.
  • name - The updated name of the camera.
  • recordingSettings
    • mode - The updated recording mode of the camera.
  • hdrMode - The updated HDR mode status (enabled or disabled).
  • ledSettings
    • isEnabled - The updated status light setting (enabled or disabled).

Dependencies

  • UniFi Protect API

Troubleshooting

  • Ensure the Camera ID is correct and exists in the UniFi Protect system; otherwise, the update will fail.
  • Verify that the API credentials are valid and have sufficient permissions to update camera settings.
  • If SSL certificate validation errors occur, consider enabling the 'Ignore SSL Issues' option, but be aware of the security risks.
  • Check proxy settings if requests are not reaching the UniFi Protect controller, especially in network-restricted environments.
  • Timeout errors may occur if the controller is slow to respond; increase the timeout setting if necessary.

Links

  • UniFi Protect API Documentation - Official documentation for the UniFi Protect API, useful for understanding available camera settings and update operations.

Discussion