Unraid icon

Unraid

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

Actions36

Docker → Stop

AI-generated

Summary

Stops a single Docker container on an Unraid server via the Unraid GraphQL API and returns the container's resulting state.

Inputs

  • Container ID (required) — Prefixed container ID (e.g. docker:abc123def456). Use the Docker Get Many operation to find IDs.
  • Maximum Control Level — Caps what this node may do (Use Credential Default, Read, Control, Full). It can only narrow the credential's limit, never exceed it. Stop is classified as a 'control' operation, so the effective level must be Control or Full; at Read the node throws an error before contacting the server.

Output shape

One item per input item, containing the container record returned by the stop mutation: id, names, state, status.

If Unraid's mutation errors with 'not found after stopping', the node re-lists containers and checks that the container is no longer RUNNING. If it is still running, it throws an error. If the container can't be found in the list, the state is reported as NOT_FOUND and the result is treated as success. In that fallback the output is either the listed container (with the full list fields) or { id, operation: 'stop', success: true, state }. With Continue On Fail enabled, errors are returned as { error: message } items.

Examples

Example 1: Stop a container before a maintenance task

Resource: Docker, Operation: Stop, Container ID: docker:abc123def456, Maximum Control Level: Use Credential Default (credential must be Control or Full).

Example 2: Let an AI Agent stop containers but nothing destructive

Use the node as an agent tool with Maximum Control Level set to Control and Container ID supplied by the agent or an expression.

Links

Discussion