Unraid icon

Unraid

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

Actions36

Array → Get Shares

AI-generated

Summary

Lists all user shares on an Unraid server via its GraphQL API, emitting one item per share with capacity and configuration details. Read-only; allowed at any control level.

Inputs

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

Output shape

One output item per user share, each with: id, name, free, used, size, include, exclude, cache, comment, color, luksStatus. Each item is paired to its input item.

Runs once per input item, so multiple input items return the share list multiple times. If the server returns no shares, no items are emitted for that input. GraphQL errors throw unless partial data is returned. With Continue On Fail enabled, errors are emitted as an item with an 'error' field.

Examples

Example 1: Alert when a share is running low on free space

Resource: Array, Operation: Get Shares. Follow with an IF node comparing free to size, then send a notification.

Example 2: Let an AI Agent inspect storage safely

Use as an agent tool with Maximum Control Level set to Read.

Links

Discussion