# JSON API

JSON API is a self-hosted infrastructure app. An Unraid plugin that reads Unraid's emhttpd statistics files and exposes them as JavaScript Object Notation (JSON), allowing services such as Home Assistant to query Unraid system data. It is open source and self-hosted, installable on Unraid.

Canonical page: https://ourlocalhost.com/app/4308/json-api

## Description

An Unraid plugin that reads Unraid's emhttpd statistics files and exposes them as JavaScript Object Notation (JSON), allowing services such as Home Assistant to query Unraid system data.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

65/100 (Good), based on 4 of 5 factors.
- Maintained: 71 (last commit 48 days ago)
- Popular: 78 (7,713 GitHub stars)
- Easy to install: 25 (1 install platform, install notes)
- Security check: 77 (no serious findings, CI, tests, OpenSSF Scorecard 4.2/10)

## Links

- Unraid: https://ca.unraid.net/apps/json-api-04jyxue1amus7u?q=JSON%20API
- Official website: https://cyanlabs.net/applications/jsonapi-unraid/
- Documentation: https://cyanlabs.net/docs

## 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.

---
Source: Our Local Host (https://ourlocalhost.com/app/4308/json-api), the self-hosted and open-source app directory.
