Skip to content

Commit 1750ed6

Browse files
authored
Add documentation to match new proxy view support (home-assistant#36747)
1 parent 1bcb56d commit 1750ed6

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

source/_integrations/unifiprotect.markdown

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -292,23 +292,27 @@ users:
292292
293293
## Views
294294
295-
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 %}.
295+
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 %}.
296296
297297
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/).
298298
299-
Three URLs for proxy API endpoints:
299+
Four URLs for proxy API endpoints:
300300
301301
`/api/unifiprotect/thumbnail/{nvr_id}/{event_id}`
302302

303303
- Proxies a JPEG event thumbnail from UniFi Protect.
304304

305-
`/api/unifiprotect/video/{nvr_id}/{camera_id}/{start}/{end}`
305+
`/api/unifiprotect/video/{nvr_id}/{event_id}`
306306

307-
- 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).
307+
- 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.
308308

309-
`/api/unifiprotect/video/{nvr_id}/{event_id}`
309+
`/api/unifiprotect/snapshot/{nvr_id}/{camera_id}/{timestamp}`
310310

311-
- 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.
311+
- 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).
312+
313+
`/api/unifiprotect/video/{nvr_id}/{camera_id}/{start}/{end}`
314+
315+
- 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).
312316

313317
`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).
314318

0 commit comments

Comments
 (0)