jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-29 20:27:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add API key creation instructions for UniFi Protect integration (#40101)

Browse Source 
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Raphael Hehl 2025-07-23 11:05:44 +02:00 committed by GitHub
parent e9234bf15f
commit cd1f4d97cd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
source/_integrations/unifiprotect.markdown
View File

@ -77,11 +77,23 @@ use has.
2. Go to **Admins & Users** from the left hand side menu and select the **Admins** tab or go to [IP address]/admins/ (e.g. _192.168.1.1/admins/_). 2. Go to **Admins & Users** from the left hand side menu and select the **Admins** tab or go to [IP address]/admins/ (e.g. _192.168.1.1/admins/_).
3. Click on **+** in the top right corner and select **Add Admin**. 3. Click on **+** in the top right corner and select **Add Admin**.
4. Select **Restrict to local access only** and enter a new _username_ and _password_. 4. Select **Restrict to local access only** and enter a new _username_ and _password_.
5. Select **Full Management** for the _Protect_ role. 5. Select **Full Management** for the _Protect_ role.
6. Click **Add** in the bottom right. 6. Click **Add** in the bottom right.
![UniFi OS User Creation](/images/integrations/unifiprotect/user.png) ![UniFi OS User Creation](/images/integrations/unifiprotect/user.png)
In addition to the username and password, you now need to create an API key for Home Assistant.
1. Log in to your _Local Portal_ on your UniFi OS device with an administrator account.
2. Go to **Settings** > **Control Plane** > **Integrations**.
3. Enter a new name for the API key, like "Home Assistant".
4. Select **Create API Key** and copy the generated key.
5. Use this API key together with your username and password when setting up the UniFi Protect integration in Home Assistant.
{% tip %}
Currently, creating an API key requires you to be logged in as an administrator.
{% endtip %}
### Camera streams ### Camera streams
The integration uses the RTSP(S) Streams as the Live Feed source, so this needs to be enabled on each camera to ensure The integration uses the RTSP(S) Streams as the Live Feed source, so this needs to be enabled on each camera to ensure