UniFi Protect icon

UniFi Protect

Interact with UniFi Protect API

Actions18

Overview

This node interacts with the UniFi Protect API to manage smart lights. Specifically, the 'Get' operation for the 'Light' resource retrieves detailed information about a single light using its unique identifier (UUID). This is useful for scenarios where you need to fetch the current state or configuration of a specific light in your UniFi Protect system, such as monitoring light status or integrating light data into automation workflows.

Use Case Examples

  1. Retrieve the status and configuration of a specific smart light by providing its Light ID.
  2. Use the 'Get' operation to fetch light details for monitoring or logging purposes in a home automation system.

Properties

Name Meaning
Light ID The unique identifier (UUID) of the light to retrieve. This is required to specify which light's information to fetch.
Request Options Additional settings for the request such as batching, SSL certificate validation, proxy configuration, and timeout settings.

Output

JSON

  • id - The unique identifier of the light.
  • name - The name of the light.
  • state - The current state of the light (e.g., on/off).
  • brightness - The brightness level of the light.
  • color - The color settings of the light, if applicable.
  • lastUpdated - Timestamp of the last update to the light's state or configuration.

Dependencies

  • UniFi Protect API

Troubleshooting

  • Ensure the Light ID provided is correct and exists in the UniFi Protect system; an invalid ID will result in an error or no data returned.
  • If SSL certificate validation fails and the 'Ignore SSL Issues' option is not enabled, the request may be blocked; enable this option only if you trust the network environment.
  • Proxy settings must be correctly configured if used; incorrect proxy details can cause connection failures.
  • Timeout settings should be adjusted based on network conditions; too short a timeout may cause premature request failures.

Links

  • UniFi Protect API Overview - Official documentation for the UniFi Protect API, useful for understanding available endpoints and data structures.

Discussion