← Directory

Unraid API

Unraid API is an MQTT and REST bridge that lets you control Unraid from Home Assistant, MQTT clients, or any REST client.

  • Home Automation
  • Tools & Utilities
Unraid API is an MQTT and REST bridge that lets you control Unraid from Home Assistant, MQTT clients, or any REST client. It is available as a Docker container and as a Unraid Community App.

Platform availability

Available on 1 of 6 install platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)

Also on Docker Hub and GitHub

Health score

67/100 Good

Maintained
100last commit 3 days ago
Popular
41113 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
No data

Based on 3 of 4 factors.

How is this calculated?

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). Factors without data are left out and the rest are rescaled.

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

GitHub stars
113
Open issues
72
Last commit
2026-10-06
Latest release
v4.37.5
Activity
declining

Checked yesterday - source: GitHub (unraid/api)

Resources & Compatibility

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

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

First-install notes

  • Start and check the API service Run `unraid-api start` to launch the service and `unraid-api status` to confirm it came up; without this you may miss a failed start. Running `unraid-api` alone prints the command list when you are unsure what options exist. source
  • Change the API port if it is taken Use `--port <number>` when starting the API to move the query port if the default is already used. This prevents the service from failing to start or becoming unreachable from other apps. source
  • Check syslog if the API does not appear When started with `unraid-api start`, the API sends logs to syslog by default. Check syslog during first startup so you can see why the service is not responding if it fails. source

Fetched 10 days ago - each note links to its source

Alternatives (9)

  • Harvester - Harvester is the next generation of open-source hyperconverged infrastructure solutions designed for modern cloud-native environments.
  • MOS (Modular Operating System) - MOS is a lightweight operating system based on Devuan, designed specifically for small, energy-efficient home servers.
  • Microsoft Hyper-V Server - Microsoft Hyper-V Server is a free product that delivers enterprise-class virtualization for your datacenter and hybrid cloud.
  • StableBit DrivePool - State of the art, file based drive pooling software.
  • TrueNAS - TrueNAS (formerly FreeNAS) is an operating system that can be installed on virtually any hardware platform to share data over a network.
  • Western Digital My Cloud - Western Digital My Cloud is an easy-to-use personal cloud storage device that plugs directly into your Wi-Fi router at home so you can pres…
  • XigmaNAS - XigmaNAS (formerly NAS4Free) is an embedded Open Source Storage NAS (Network-Attached Storage) distribution based on FreeBSD.
  • ZimaOS - A simplified, focused and open NAS OS that supports all X86-64 hardware.
  • openmediavault - OpenMediaVault turns an old computer or Raspberry Pi into your own private cloud storage.

Checked 7 days ago - source: AlternativeTo

Common questions

How do I avoid the Unraid API failing to start if its query port is already taken?

Use `--port <number>` when starting the API to change the query port. This prevents the service from failing to start or becoming unreachable from other apps.

Where should I look if the API starts but does not respond on first launch?

Check syslog, because `unraid-api start` sends logs there by default. It shows why the service is not responding if it fails.

Which commands let me verify the API is healthy or produce troubleshooting data?

Use `unraid-api status` to monitor the API's health. Use `unraid-api report` to generate reports for troubleshooting.

What do I need to include when asking for help with an Unraid API error?

Provide a more complete description of the problem. Attach diagnostics to your next post in the thread.

Which forum should I use for API setup questions rather than Unraid Connect problems?

Use the Unraid API Support forum for questions and help with the Unraid API. It is not for Unraid Connect issues such as remote access or dashboard problems.

Answers sourced from docs.unraid.net, forums.unraid.net, forums.unraid.net, github.com, github.com

Community

Collected 9 days ago - public community threads