Dashboard API: real-time router stats endpoints

The Dashboard API provides read-only access to live monitoring data from the connected OpenWrt router. Every endpoint establishes an SSH session on request using the credentials configured in your environment, executes one or more shell commands on the router, and returns the output as JSON. No request body or query parameters are required for any of these endpoints.

All endpoints require an active router session. If the SSH connection fails — for example, because the router is unreachable or credentials are wrong — every endpoint returns HTTP 500 with { "status": "error", "message": "..." }. See the authentication guide for session setup.

GET /api/dashboard/data

Returns a comprehensive snapshot of the router’s system state. Internally calls SystemRouterService::getSystemInfo(), which collects hostname, current time, uptime, load averages, memory, CPU model, network interfaces, and kernel version over SSH.

Request parameters

No parameters.

Response schema

status

string

required

Result of the operation. Either "success" or "error".

data

object

required

System information object collected from the router.

Show properties

hostname

string

Router hostname, read from uci get system.@system[0].hostname.

time

string

Current date and time on the router (output of date).

uptime

string

Human-readable uptime string (output of uptime).

load

string

Space-separated 1-minute, 5-minute, and 15-minute load averages from /proc/loadavg.

memory

object

Memory breakdown by category.

Show properties

mem

object

RAM statistics.

Show properties

total

number

Total RAM in MB.

used

number

Used RAM in MB.

free

number

Free RAM in MB.

swap

object

Swap statistics (same shape as mem).

cpu

string

CPU model name from /proc/cpuinfo.

interfaces

array

List of non-loopback network interfaces.

Show item properties

name

string

Interface name (e.g., eth0, wlan0).

status

string

Link state reported by ip -br link (e.g., UP, DOWN).

kernel

string

Kernel version string from uname -r.

model

string

Router hardware model from /tmp/sysinfo/model.

Example

Request
Success response
Error response

curl -X GET http://your-app.test/api/dashboard/data \
  -H "Accept: application/json"

{
  "status": "success",
  "data": {
    "hostname": "OpenWrt",
    "time": "Mon May 19 10:24:01 UTC 2026",
    "uptime": " 10:24:01 up 2 days,  3:12,  load average: 0.08, 0.04, 0.01",
    "load": "0.08 0.04 0.01",
    "memory": {
      "mem": { "total": 128, "used": 54, "free": 74 },
      "swap": { "total": 0, "used": 0, "free": 0 }
    },
    "cpu": " MIPS 24Kc V7.4",
    "interfaces": [
      { "name": "eth0", "status": "UP" },
      { "name": "wlan0", "status": "UP" }
    ],
    "kernel": "5.15.150",
    "model": "TP-Link TL-WR841N v14"
  }
}

{
  "status": "error",
  "message": "No se pudo conectar por SSH al router. Revisa usuario o contrasena."
}

GET /api/dashboard/realtime

Returns live system metrics gathered from the router in a single SSH session burst. Use this endpoint for polling dashboards that display current CPU load, memory consumption, and network connection counts. Shell commands executed:

Field	Command
`cpu`	`top -bn1 \| grep 'Cpu(s)' \| awk '{print $2}' \| cut -d'%' -f1`
`memory`	`free -m \| grep Mem \| awk '{print $3}'`
`memory_total`	`free -m \| grep Mem \| awk '{print $2}'`
`load`	`cat /proc/loadavg \| cut -d' ' -f1-3`
`connections`	`netstat -an \| grep ESTABLISHED \| wc -l`
`uptime`	`cat /proc/uptime \| awk '{print int($1/3600)"h "int(($1%3600)/60)"m"}'`

Request parameters

No parameters.

Response schema

status

string

required

"success" or "error".

data

object

required

Live metrics object.

Show properties

cpu

string

CPU usage percentage as a numeric string (e.g., "12.5"), from top -bn1.

memory

string

Used memory in MB as a numeric string (e.g., "54"), from free -m.

memory_total

string

Total installed memory in MB as a numeric string (e.g., "128"), from free -m.

load

string

Space-separated load averages for 1m, 5m, and 15m intervals (e.g., "0.08 0.04 0.01").

connections

string

Count of ESTABLISHED TCP connections as a numeric string, from netstat -an.

uptime

string

Router uptime formatted as "Xh Ym" (e.g., "51h 12m"), derived from /proc/uptime.

Example

Request
Success response
Error response

curl -X GET http://your-app.test/api/dashboard/realtime \
  -H "Accept: application/json"

{
  "status": "success",
  "data": {
    "cpu": "12.5",
    "memory": "54",
    "memory_total": "128",
    "load": "0.08 0.04 0.01",
    "connections": "3",
    "uptime": "51h 12m"
  }
}

{
  "status": "error",
  "message": "No se pudo conectar por SSH al router. Revisa usuario o contrasena."
}

GET /api/dashboard/firewall

Returns the active iptables ruleset from the router. Executes iptables -L -n -v | head -100 and returns the raw text output, capped at 100 lines.

Request parameters

No parameters.

Response schema

status

string

required

"success" or "error".

data

string

required

Raw output of iptables -L -n -v | head -100. Contains chain headers, column labels, and one rule per line.

Example

Request
Success response
Error response

curl -X GET http://your-app.test/api/dashboard/firewall \
  -H "Accept: application/json"

{
  "status": "success",
  "data": "Chain INPUT (policy ACCEPT 0 packets, 0 bytes)\n pkts bytes target     prot opt in     out     source               destination\n    0     0 ACCEPT     all  --  lo     *       0.0.0.0/0            0.0.0.0/0\nChain FORWARD (policy DROP 0 packets, 0 bytes)\n..."
}

{
  "status": "error",
  "message": "No se pudo conectar por SSH al router. Revisa usuario o contrasena."
}

GET /api/dashboard/routes

Returns the kernel routing table of the router. Executes ip route show over SSH and returns its raw output.

Request parameters

No parameters.

Response schema

status

string

required

"success" or "error".

data

string

required

Raw output of ip route show. Each line represents one routing entry.

Example

Request
Success response
Error response

curl -X GET http://your-app.test/api/dashboard/routes \
  -H "Accept: application/json"

{
  "status": "success",
  "data": "default via 192.168.1.1 dev eth0 proto static\n192.168.1.0/24 dev eth0 proto kernel scope link src 192.168.1.100\n192.168.10.0/24 dev eth1 proto kernel scope link src 192.168.10.1\n"
}

{
  "status": "error",
  "message": "No se pudo conectar por SSH al router. Revisa usuario o contrasena."
}

GET /api/dashboard/syslog

Returns the last 100 entries from the router’s system log. Executes logread | tail -100 via SSH. On OpenWrt, logread reads from the in-memory ring buffer maintained by the logd daemon.

Request parameters

No parameters.

Response schema

status

string

required

"success" or "error".

data

string

required

Raw syslog output — up to 100 lines, each prefixed with a timestamp and facility tag.

Example

Request
Success response
Error response

curl -X GET http://your-app.test/api/dashboard/syslog \
  -H "Accept: application/json"

{
  "status": "success",
  "data": "Mon May 19 10:20:01 2026 daemon.info dnsmasq[1234]: reading /etc/resolv.conf\nMon May 19 10:21:00 2026 kern.info kernel: br-lan: port 1(eth0.1) entered forwarding state\n..."
}

{
  "status": "error",
  "message": "No se pudo conectar por SSH al router. Revisa usuario o contrasena."
}

GET /api/dashboard/kernel

Returns the last 100 kernel log messages from the router. Executes dmesg | tail -100 via SSH.

Request parameters

No parameters.

Response schema

status

string

required

"success" or "error".

data

string

required

Raw dmesg output — up to 100 lines of kernel ring buffer messages.

Example

Request
Success response
Error response

curl -X GET http://your-app.test/api/dashboard/kernel \
  -H "Accept: application/json"

{
  "status": "success",
  "data": "[    0.000000] Linux version 5.15.150\n[    0.012000] Calibrating delay loop... 532.48 BogoMIPS\n[43821.104000] br-lan: port 2(wlan0) entered forwarding state\n..."
}

{
  "status": "error",
  "message": "No se pudo conectar por SSH al router. Revisa usuario o contrasena."
}

GET /api/dashboard/processes

Returns the list of running processes on the router. Executes ps aux | head -100 via SSH, returning up to 100 process entries.

Request parameters

No parameters.

Response schema

status

string

required

"success" or "error".

data

string

required

Raw ps aux output — a header line followed by one process per line, capped at 100 lines.

Example

Request
Success response
Error response

curl -X GET http://your-app.test/api/dashboard/processes \
  -H "Accept: application/json"

{
  "status": "success",
  "data": "PID   USER       VSZ STAT COMMAND\n    1 root      1544 S    /sbin/procd\n  241 root      1212 S    /sbin/ubusd\n  534 root      1480 S    /usr/sbin/dropbear -F -P /var/run/dropbear.1.pid\n..."
}

{
  "status": "error",
  "message": "No se pudo conectar por SSH al router. Revisa usuario o contrasena."
}

Error handling

All Dashboard API endpoints share the same error contract. When an SSH connection cannot be established or a remote command fails, the endpoint returns HTTP 500 with the following body:

{
  "status": "error",
  "message": "No se pudo conectar por SSH al router. Revisa usuario o contrasena."
}

Each endpoint opens a new SSH connection. If the router is under load or has connection limits set, rapid successive calls to multiple endpoints may be throttled or refused. Space out polling intervals accordingly — 5 seconds is a reasonable minimum for realtime stats.

Common causes of SSH errors:

Wrong credentials — check ROUTER_IP, ROUTER_USER, and ROUTER_PASSWORD in your .env file.
Router unreachable — verify network connectivity from the web server to ROUTER_IP:ROUTER_PORT.
SSH daemon not running — on OpenWrt, ensure dropbear is active: service dropbear status.

For configuration details see the configuration guide and the authentication API reference.

Authentication

Router API

Dashboard API

Dashboard API: real-time router stats endpoints

GET /api/dashboard/data

Request parameters

Response schema

Example

GET /api/dashboard/realtime

Request parameters

Response schema

Example

GET /api/dashboard/firewall

Request parameters

Response schema

Example

GET /api/dashboard/routes

Request parameters

Response schema

Example

GET /api/dashboard/syslog

Request parameters

Response schema

Example

GET /api/dashboard/kernel

Request parameters

Response schema

Example

GET /api/dashboard/processes

Request parameters

Response schema

Example

Error handling

Build docs developers (and LLMs) love

Authentication

Router API

Dashboard API

Documentation Index

​GET /api/dashboard/data

​Request parameters

​Response schema

​Example

​GET /api/dashboard/realtime

​Request parameters

​Response schema

​Example

​GET /api/dashboard/firewall

​Request parameters

​Response schema

​Example

​GET /api/dashboard/routes

​Request parameters

​Response schema

​Example

​GET /api/dashboard/syslog

​Request parameters

​Response schema

​Example

​GET /api/dashboard/kernel

​Request parameters

​Response schema

​Example

​GET /api/dashboard/processes

​Request parameters

​Response schema

​Example

​Error handling

Build docs developers (and LLMs) love

GET /api/dashboard/data

Request parameters

Response schema

Example

GET /api/dashboard/realtime

Request parameters

Response schema

Example

GET /api/dashboard/firewall

Request parameters

Response schema

Example

GET /api/dashboard/routes

Request parameters

Response schema

Example

GET /api/dashboard/syslog

Request parameters

Response schema

Example

GET /api/dashboard/kernel

Request parameters

Response schema

Example

GET /api/dashboard/processes

Request parameters

Response schema

Example

Error handling