Unraid

The Unraid API integration allows users to integrate their Unraid server using Unraids local GraphQL API.

Install the Integration

1. Go to the HACS -> Custom Repositories and add this repository as a Custom Repository See HACS Documentation for help

2. Click the button bellow and click 'Download' to install the Integration:

   

3. Restart Home Assistant.

Prerequisites

• Unraid v7.2 or later

• Create an API Key with this Template:

  ?name=Homeassistant&scopes=array%2Bdisk%2Binfo%2Bservers%2Bshare%3Aread_any&description=Unraid+API+Homeassistant+integration

  or set permissions manully:

  • Resources:

    • Info
    • Servers
    • Array
    • Disk
    • Share

  • Actions: Read (All)

Setup

1. Click the button below or use "Add Integration" in Home Assistant and select "Unraid".

   

2. Enter the URL of the Unraid WebUI and your API Key

3. Select if you want to monitor disk and shares

Configuration parameters

• Unraid WebUI: URL of the Unraid WebUI (including "http(s)://")
• API Key: API Key for the Unraid API
• Monitor Shares: Create Entities for each Network Share
• Monitor Disks: Create Entities for each Disk

Entities

• State of the Array ("Stopped", "Started", ...)

• Percentage of used space on the Array

• Percentage of used RAM

• CPU utilization

• When "Monitor Shares" enabled:

  • Free space for each Share

• When "Monitor Disks" enabled, for each Disk, including Cache disks:

  • State of the Disk
  • Disk Temperature (Temperature is unknown for spun down disk)
  • Disk spinning
  • Percentage of used space on the Disk

Remove integration

This integration follows standard integration removal, no extra steps are required.