Unraid Simple Monitoring API

Unraid Simple Monitoring API is a lightweight REST API that reports Unraid disk utilization and status, network traffic, CPU load and temperature, and memory…

  • Monitoring & Logging
  • Network Services
  • Tools & Utilities
Unraid Simple Monitoring API is a lightweight REST API that reports Unraid disk utilization and status, network traffic, CPU load and temperature, and memory usage for dashboards such as Homepage.

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.

45/100 Fair

Maintained
28last commit 445 days ago
Popular
3767 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
No data
Security check
100no serious findings, CI, tests

Based on 4 of 5 factors.

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

GitHub stars
67
Open issues
1
Last commit
2025-09-02
Latest release
v0.4.0
License
MIT
Activity
stale

Checked 10 days ago - source: GitHub (NebN/unraid-simple-monitoring-api)

Resources & Compatibility

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

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

First-install notes

  • Create .env before starting Run `pnpm run env:init` to create the initial .env (the file that holds settings), then edit the values your setup needs. Without this file, the app may not have the settings it expects and can fail or behave oddly. source
  • Start the API and check syslog Run `unraid-api start` to launch the API. Logs are sent to syslog by default, so check there if it fails or behaves unexpectedly. source
  • Set a free GraphQL port if needed You can use the `--port` option to change the GraphQL (API query) port if the default is already taken. If another app is using the same port, the API may not start correctly. source
  • Configuration The application expects a conf.yml file in /mnt/user/appdata/Unraid-simple-monitoring-api before first start; use the example from the GitHub repository. source

Fetched 38 days ago - each note links to its source

Alternatives (4)

  • Live Server - Launch a local development server with live reload feature for static & dynamic pages.
  • LocaltoNet - Localtonet is a reverse-proxy tunneling service that securely exposes local HTTP, TCP, and UDP services on your network to a temporary publ…
  • ngrok - ngrok creates secure tunnels from the internet to your local network, letting you expose local development servers, APIs, and applications…
  • simple web server - Simple Web Server is a user-friendly desktop application that lets you share folders or files and preview websites over your network withou…

Checked 40 days ago - source: AlternativeTo

Common questions

Where should I look for the default configuration file?

It expects a conf.yml file in /mnt/user/appdata/Unraid-simple-monitoring-api/conf.yml.

What port should I use to request metrics?

Send requests to the Unraid host using port 24940.

Which metrics does the API expose?

It reports disk utilization and status, network traffic, CPU load and temperature, and memory utilization.

How can I install it on Unraid?

It can be installed from Community Apps on the Unraid server.

Answers sourced from ca.unraid.net, github.com

Community

Collected 53 days ago - public community threads