# Unraid-API-RE

Unraid-API-RE is a community-maintained fork of the original UnraidAPI that connects Unraid to Home Assistant and other home-automation systems using MQTT (Message Queuing Telemetry Transport) and REST. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/1386/unraid-api-re

## Description

Unraid-API-RE is a community-maintained fork of the original UnraidAPI that connects Unraid to Home Assistant and other home-automation systems using MQTT (Message Queuing Telemetry Transport) and REST (Representational State Transfer). It runs as a Docker container and exposes both an MQTT bridge and a REST endpoint, letting you monitor and control your Unraid server from Home Assistant, other MQTT or REST tools, or a browser dashboard. It suits homelab users who want reliable Unraid integration now that the original project is no longer maintained.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

67/100 (Good), based on 3 of 4 factors.
- Maintained: 99 (last commit 39 days ago)
- Popular: 41 (115 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Docker Hub: https://hub.docker.com/repository/docker/bokker/unraidapi-re
- Unraid: https://ca.unraid.net/apps/unraid-api-re-14qk7ef1nblvbf?q=Unraid-API-RE

## Common questions

### Can Unraid-API-RE be used as a JSON API for a custom server dashboard?

Yes, a self-hosted user used it to get a JSON API for their Unraid instances and built their own API wrappers for other services.

### Which Docker image tag should I pick for a particular Unraid release?

The tags follow Unraid major releases and should also work for minor releases.

### What problem has been reported when replacing the original UnraidAPI with Unraid-API-RE?

Some users could not control Unraid after switching, including VM connection issues, even with latest Unraid and Home Assistant and after resetting the app.

### What VM sensor issue has appeared after recent Unraid updates?

The VM sensor may fail to update after a Home Assistant restart.

### Why might the Unraid API container still be over 1 GB?

A reported cause is that the container is still running in dev mode, which can make the container unusually large.

---
Source: Our Local Host (https://ourlocalhost.com/app/1386/unraid-api-re), the self-hosted and open-source app directory.
