Unraid icon

Unraid

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

Actions36

System → Get Online Status

AI-generated

Summary

Checks whether the Unraid server's GraphQL API reports it as online, returning a single item with a boolean online field.

Inputs

  • Maximum Control Level — Caps what this node may do. Options: Use Credential Default (default), Read, Control, Full. It can only narrow the credential's limit, never exceed it. This operation is read-only, so any level works.

Output shape

A single item with the JSON { "online": <boolean> }. It is paired with the input item.

The node sends a GraphQL query { online } to <serverUrl>/graphql and returns online: false if the response has no value. If the server can't be reached, or the API returns errors with no data, the node throws an error instead of returning false. With Continue On Fail enabled, the error is returned as { error: message }. The node runs once per input item.

Examples

Example 1: Run a scheduled health check and alert if the Unraid API reports the server as not online.

Resource: System, Operation: Get Online Status, Maximum Control Level: Use Credential Default. Follow with an IF node on {{$json.online}}.

Example 2: Give an AI Agent a safe tool to check server availability.

Resource: System, Operation: Get Online Status, Maximum Control Level: Read.

Links

Discussion