Skip to content

REST and SSE API ​

All JSON endpoints return an envelope format:

json
{
  "ok": true,
  "data": { ... }
}
MethodEndpointDescription
GET/api/healthOverall health state, PID, uptime, Node version, and current lag.
GET/api/memoryProcess memory stats (RSS, heapUsed, heapTotal, external).
GET/api/cpuProcess CPU percentages (total, user, system).
GET/api/event-loopCurrent, maximum, and average event-loop lag times.
GET/api/requestsRecent HTTP traffic buffer and aggregate metrics.
GET/api/outgoingRecent outgoing HTTP calls with status and duration.
GET/api/queriesRecent database queries with slow and N+1 flags.
GET/api/errorsGrouped errors with counts, stacks and last request.
GET/api/routesDeclared routes (Express, Fastify, NestJS, Hapi, Hono).
GET/api/logsCaptured console logs buffer with timestamp and level.
GET/api/envMasked environment variables and app configurations.
GET/api/startupStartup timeline marks registered via server.mark().
GET/api/metricsPer-second request and error buckets for the last minute.
GET/api/configEffective (non-secret) configuration, panel list and plugin meta.
GET/api/<plugin-id>Output of each registered custom panel (plugins option).
GET/api/liveServer-Sent Events (SSE) real-time metric stream.
POST/api/confirmationsIssues a single-use cryptographic token for mutating actions.
POST/api/heap-snapshotTakes a V8 heap snapshot (requires x-nodeui-confirm header).

Released under the Apache-2.0 License.