Unraid API
Unraid API is an MQTT and REST bridge that lets you control Unraid from Home Assistant, MQTT clients, or any REST client.
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.
69/100 Good
- Maintained
- 100last commit 24 days ago
- Popular
- 42119 GitHub stars
- Easy to install
- 351 install platform, install notes, Docker image
- Light to run
- No data
- Security check
- 76no serious findings, 4 minor, CI, tests
Based on 4 of 5 factors.
Availability: platform listings confirmed today, links checked 51 days ago
- GitHub stars
- 119
- Open issues
- 75
- Last commit
- 2026-10-28
- Latest release
- v4.37.9
- Activity
- rising
Checked 20 days ago - source: GitHub (unraid/api)
Resources & Compatibility
Minimum requirements: 4 CPU core(s). 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 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 54 days ago - each note links to its source
Variants
Alternatives
No alternatives collected yet.
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
- self-hosted photo video storage - Lounge - Unraid (forum)
- Unraid API Support (forum)
- Unraid API / Unraid Connect - Unraid (forum)
Collected 53 days ago - public community threads