Unraid icon

Unraid

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

Actions36

System → Get UPS Status

AI-generated

Summary

Query the Unraid server's GraphQL API for attached UPS devices and return each device's status, model, battery and power details. If no UPS is connected, it returns a single {connected: false} item instead of failing.

Inputs

  • maxControlLevel — Caps the control level for this node. It can only narrow the credential's limit, never raise it. Default is 'Use Credential Default'. Get UPS Status is a read-only operation, so it runs at any level (Read, Control or Full).

Output shape

One output item per UPS device, with fields id, name, status, model, battery {chargeLevel, estimatedRuntime, health} and power {inputVoltage, outputVoltage, loadPercentage}. If no devices are returned, a single item { "connected": false }.

The Unraid API throws 'No UPS data returned from apcaccess' when no UPS is attached. The node catches any error whose message mentions 'ups' or 'apcaccess' and returns {connected: false}. Other errors, such as auth or network failures, are thrown. With Continue On Fail enabled they become {error: message} items. Each output item is paired to its input item, so one query runs per input item.

Examples

Example 1: Alert when UPS battery is low

Resource: System, Operation: Get UPS Status, followed by an IF node on battery.chargeLevel below a threshold and a notification node.

Example 2: Check whether a UPS is present before a shutdown workflow

Resource: System, Operation: Get UPS Status. Branch on connected equal to false versus a status of on-battery.

Example 3: Use as a safe AI Agent tool

Resource: System, Operation: Get UPS Status, Maximum Control Level: Read, so the model can only read data.

Links

Discussion