# Unraid API Unraid API is an MQTT and REST bridge that lets you control Unraid from Home Assistant, MQTT clients, or any REST client. It is open source and self-hosted, installable on Docker Hub and Unraid. Canonical page: https://ourlocalhost.com/app/943/unraid-api ## Description 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 9 platforms: Unraid. ## Health score 67/100 (Good), based on 3 of 4 factors. - Maintained: 100 (last commit 16 days ago) - Popular: 41 (113 GitHub stars) - Easy to install: 35 (1 install platform, install notes, Docker image) ## Links - GitHub: https://github.com/unraid/api - Docker Hub: https://hub.docker.com/r/electricbrainuk/unraidapi - Unraid: https://ca.unraid.net/apps/unraid-api-0hxu9n007hskjk?q=Unraid-API ## Common questions ### How do I avoid the Unraid API failing to start if its query port is already taken? Use `--port ` 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. --- Source: Our Local Host (https://ourlocalhost.com/app/943/unraid-api), the self-hosted and open-source app directory.