UniFi Protect icon

UniFi Protect

Interact with UniFi Protect API
Join our community

Actions18

Overview

This node interacts with the UniFi Protect API to update sensor information. It allows users to modify specific fields of a sensor, such as its name and status light settings, by specifying the sensor's unique identifier (UUID). This operation is useful for managing and customizing sensor configurations within a UniFi Protect system, for example, renaming a sensor or enabling/disabling its status light.

Use Case Examples

  1. Updating the name of a sensor to 'Front Door Sensor'.
  2. Disabling the status light of a sensor for stealth operation.

Properties

Name Meaning
Sensor ID The unique identifier (UUID) of the sensor to update. This is required to specify which sensor to modify.
Update Fields A collection of fields to update on the sensor, including 'Name' (the sensor's name) and 'Status Light' (whether the sensor's status light is enabled).
Request Options Settings to control request behavior such as batching, SSL certificate validation, proxy usage, and request timeout.

Output

JSON

  • id - The unique identifier of the updated sensor.
  • name - The updated name of the sensor.
  • ledSettings
    • isEnabled - The updated status light setting indicating if the sensor's status light is enabled or disabled.

Dependencies

  • Requires an API key credential for UniFi Protect API authentication.

Troubleshooting

  • Ensure the Sensor ID is correct and exists in the UniFi Protect system; otherwise, the update will fail.
  • If SSL certificate validation fails and 'Ignore SSL Issues' is not enabled, requests may be blocked; enable this option cautiously if needed.
  • Proxy settings must be correctly configured if used, including authentication details if required.
  • Timeout settings should be adjusted based on network conditions to avoid premature request termination.

Links

Discussion