Unraid icon

Unraid

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

Actions36

Array → Stop

AI-generated

Summary

Stops the Unraid array by sending a GraphQL setState mutation with desiredState STOP, and returns the resulting array id and state. This is classified as destructive and requires the Full control level.

Inputs

  • maxControlLevel — Caps what this node may do: Use Credential Default (default), Read, Control, or Full. It can only narrow the credential's limit, never raise it. Stop Array needs an effective level of Full, so both the credential and this node must allow Full. Otherwise the node throws an error before contacting the server.

Output shape

One item per input item, with the setState result: { id, state } for the array after the stop request.

If the response has no setState data, the item is an empty object. If the effective control level is below Full, the item errors, or with Continue On Fail it returns { error: message }. Stopping the array also stops all Docker containers. If n8n runs on the same Unraid host, it stops n8n itself, so the workflow may not finish. With several input items, the stop mutation runs once per item.

Examples

Example 1: Final step of a UPS shutdown workflow run from a remote n8n instance

Resource: Array, Operation: Stop, Maximum Control Level: Use Credential Default, with the Unraid credential set to Full.

Example 2: Restrict an AI Agent tool so it cannot stop the array

Resource: Array, Operation: Stop, Maximum Control Level: Control. The call fails with a control-level error.

Links

Discussion