Unraid icon

Unraid

Interact with the Unraid API — manage Docker containers, VMs, array health, disks, notifications, and system metrics

Actions36

System → Get Metrics

AI-generated

Summary

Fetches a live snapshot of CPU and memory usage from the Unraid server's GraphQL API and returns it as a single item. It's a read-only operation.

Inputs

  • Maximum Control Level — Optional cap on what this node may do (Use Credential Default, Read, Control, Full). It can only narrow the credential's limit. Get Metrics is a read operation, so it runs at any level.

Output shape

One item per input item. Each item holds the metrics object: id, cpu (percentTotal and a cpus array with per-core percentTotal, percentUser, percentSystem, percentIdle), and memory (total, used, free, available, active, buffcache, percentTotal).

If the API returns no metrics, the item is an empty object. If the API returns errors alongside partial data, the partial data is used. Otherwise the node throws, or emits an error field when Continue On Fail is enabled. The query takes no filters or parameters, and values are a point-in-time reading.

Examples

Example 1: Alert when memory usage is high

Schedule Trigger → Unraid (System > Get Metrics) → IF on memory.percentTotal > 90 → send a notification.

Example 2: Give an AI Agent read-only access to server load

Use the Unraid node as an agent tool with System > Get Metrics and Maximum Control Level set to Read.

Links

Discussion