# 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 usage for dashboards such as Homepage. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/1916/unraid-simple-monitoring-api

## Description

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.

## Health score

45/100 (Fair), based on 4 of 5 factors.
- Maintained: 28 (last commit 445 days ago)
- Popular: 37 (67 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Security check: 100 (no serious findings, CI, tests)

## Links

- GitHub: https://github.com/NebN/unraid-simple-monitoring-api
- Docker Hub: https://hub.docker.com/r/nebn/unraid-simple-monitoring-api
- Official website: https://gethomepage.dev
- Unraid: https://ca.unraid.net/apps/unraid-simple-monitoring-api-0w6am420narkpa?q=unraid-simple-monitoring-api

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

## Alternatives

- Live Server: Launch a local development server with live reload feature for static &amp; 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…

---
Source: Our Local Host (https://ourlocalhost.com/app/1916/unraid-simple-monitoring-api), the self-hosted and open-source app directory.
