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…

  • Home Automation
  • Infrastructure
  • Tools & Utilities
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
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

67/100 Good

Maintained
99last commit 39 days ago
Popular
41115 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
No data

Based on 3 of 4 factors.

Availability: platform listings confirmed today, links checked 43 days ago

No GitHub repository data collected yet.

Resources & Compatibility

ARM (e.g. Raspberry Pi) is not supported.

Checked 54 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Start and check the API Run `unraid-api start` to start the API service (the program the Unraid UI uses to talk to the server), then use `unraid-api status` to confirm it is running. If it is not running, the Unraid web UI and plugins may fail to connect. source
  • Check the API logs in syslog By default, the API sends logs to syslog (the system's built-in log area). This helps you spot startup failures, missing settings, or connection errors. source
  • Use the command-line help menu Run `unraid-api` by itself to see supported commands and options such as `--port`, `--environment`, and `--log-level`. If you change the API port with `--port`, allow that port in your firewall so Unraid can reach the service. source

Fetched 54 days ago - each note links to its source

Alternatives

No alternatives collected yet.

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.

Answers sourced from forums.unraid.net, forums.unraid.net, github.com, www.reddit.com

Community

Collected 48 days ago - public community threads