Skip to content

Commit

Permalink
Add documentation to match new proxy view support (#36747)
Browse files Browse the repository at this point in the history
  • Loading branch information
EliSchleifer authored Jan 6, 2025
1 parent 1bcb56d commit 1750ed6
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions source/_integrations/unifiprotect.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -292,23 +292,27 @@ users:
## Views
The {% term integrations %} provides two proxy views to proxy media content from your Home Assistant instance so you can access thumbnails and video clips from within the context of Home Assistant without having to expose your UniFi Protect NVR Console. As with the media identifiers, all IDs are UniFi Protect IDs as they may not map to specific Home Assistant entities depending on how you have configured your {% term integrations %}.
The {% term integrations %} provides four proxy views to proxy media content from your Home Assistant instance so you can access thumbnails and video clips from within the context of Home Assistant without having to expose your UniFi Protect NVR Console. As with the media identifiers, all IDs are UniFi Protect IDs as they may not map to specific Home Assistant entities depending on how you have configured your {% term integrations %}.
These URLs work great when trying to send notifications. Home Assistant will automatically sign the URLs and make them safe for external consumption if used in an {% term automation %} or [notify action](/integrations/notify/).
Three URLs for proxy API endpoints:
Four URLs for proxy API endpoints:
`/api/unifiprotect/thumbnail/{nvr_id}/{event_id}`

- Proxies a JPEG event thumbnail from UniFi Protect.

`/api/unifiprotect/video/{nvr_id}/{camera_id}/{start}/{end}`
`/api/unifiprotect/video/{nvr_id}/{event_id}`

- Proxies a MP4 video clip from UniFi Protect for a specific camera. Start and end must be in [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html).
- Proxies a MP4 video clip from UniFi Protect for a specific event. To get the video, the event needs to be finished. If it's still ongoing, use the camera endpoint defined below.

`/api/unifiprotect/video/{nvr_id}/{event_id}`
`/api/unifiprotect/snapshot/{nvr_id}/{camera_id}/{timestamp}`

- Proxies a MP4 video clip from UniFi Protect for a specific event. To get the video, the event needs to be finished. If it's still ongoing, use the camera endpoint defined above.
- Proxies a JPEG from UniFi Protect for a specific camera at the specified timestamp. timestamp must be in [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html).

`/api/unifiprotect/video/{nvr_id}/{camera_id}/{start}/{end}`

- Proxies a MP4 video clip from UniFi Protect for a specific camera. Start and end must be in [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html).

`nvr_id` can either be the UniFi Protect ID of your NVR or the config entry ID for your UniFi Protect {% term integrations %}. `camera_id` can either be the UniFi Protect ID of your camera or an entity ID of any {% term entity %} provided by the UniFi Protect {% term integrations %} that can be reversed to a UniFi Protect camera (i.e., an entity ID of a detected object sensor).

Expand Down

0 comments on commit 1750ed6

Please sign in to comment.