UniFi Protect icon

UniFi Protect

Interact with UniFi Protect API

Actions18

Overview

This node interacts with the UniFi Protect API to manage and retrieve data from UniFi Protect cameras. Specifically, the 'Get Snapshot' operation allows users to obtain a snapshot image from a specified camera by providing its unique identifier (UUID). This is useful for security monitoring, capturing real-time images from surveillance cameras, or integrating camera snapshots into automated workflows.

Use Case Examples

  1. Retrieve a snapshot from a specific camera to display in a dashboard.
  2. Automatically capture and save snapshots from cameras at scheduled intervals for security records.

Properties

Name Meaning
Camera ID The unique identifier (UUID) of the camera from which to get the snapshot. This is required to specify which camera's snapshot to retrieve.
Request Options Additional options to customize the request behavior, including batching of requests, SSL certificate validation, proxy settings, and request timeout.

Output

JSON

  • snapshotUrl - URL or data of the snapshot image retrieved from the camera.
  • cameraId - The unique identifier of the camera from which the snapshot was taken.
  • timestamp - The time at which the snapshot was captured.

Dependencies

  • UniFi Protect API

Troubleshooting

  • Ensure the Camera ID is correct and corresponds to an existing camera in the UniFi Protect system.
  • Check network connectivity and API credentials to ensure the node can communicate with the UniFi Protect controller.
  • If SSL certificate validation fails, consider enabling the 'Ignore SSL Issues' option, but be aware of security risks.
  • Verify proxy settings if a proxy is required for network access.
  • Adjust the timeout setting if requests are timing out due to slow network or server response.

Links

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

Discussion