JSON API
An Unraid plugin that reads Unraid's emhttpd statistics files and exposes them as JavaScript Object Notation (JSON), allowing services such as Home Assistant…
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.
65/100 Good
- Maintained
- 71last commit 48 days ago
- Popular
- 787,713 GitHub stars
- Easy to install
- 251 install platform, install notes
- Light to run
- No data
- Security check
- 77no serious findings, CI, tests, OpenSSF Scorecard 4.2/10
Based on 4 of 5 factors.
Availability: platform listings confirmed today, links checked 3 days ago
- GitHub stars
- 7,713
- Open issues
- 150
- Last commit
- 2026-10-04
- License
- CC0-1.0
- Activity
- stale
Checked yesterday - source: GitHub (json-api/json-api)
Resources & Compatibility
Requirements not published yet.
First-install notes
- Docker must be running before setup Install and keep Docker (a tool that runs apps in safe, isolated boxes) running before you run the tutorial setup command. If Docker is not running, the project setup will not work and the app will not start. source
- Start the app with Laravel Sail After setup, run the Sail command (Laravel’s Docker helper) in the project folder to start the local app containers. If you skip this step, the JSON:API service is not running and you cannot test it. source
- Add the JSON:API package first Use Composer (the tool that adds PHP packages) to install the main JSON:API package for Laravel (a PHP web framework). Without it, your app does not have the code needed to serve JSON:API responses. source
- Unraid plugin only This is an Unraid plugin; it exposes Unraid statistics as JSON and does not provide a web frontend. source
Fetched 48 days ago - each note links to its source
Variants
Alternatives
No alternatives collected yet.
Common questions
Which Unraid files does the plugin convert to JSON?
It reads the statistics files under /var/local/emhttp/*.ini used by Unraid and emhttpd.
How do I request disk statistics from the plugin?
Query the plugin's api.php endpoint with the disks.ini file parameter.
Does the plugin include a web interface?
No, it has no frontend and is only accessible directly through its JSON API.
Can Home Assistant query Unraid data through it?
Yes, the plugin is designed to expose Unraid statistics as JSON for services such as Home Assistant.
Answers sourced from cyanlabs.net
Community
- File explorer with JSON API : r/selfhosted - Reddit (reddit)
- Faq - Json Api (forum)
- Json Api (forum)
- Is anyone using JSON API? : r/ExperiencedDevs - Reddit (reddit)
Collected 48 days ago - public community threads