Unraid API Skill

Query and monitor Unraid servers using the GraphQL API. Access all 27 read-only endpoints for system monitoring, disk health, logs, containers, VMs, and more.

Quick Start

Set your Unraid server credentials:

```bash

export UNRAID_URL="https://your-unraid-server/graphql"

export UNRAID_API_KEY="your-api-key"

```

**Get API Key:** Settings → Management Access → API Keys → Create (select "Viewer" role)

Use the helper script for any query:

```bash

./scripts/unraid-query.sh -q "{ online }"

```

Or run example scripts:

```bash

./scripts/dashboard.sh # Complete multi-server dashboard

./examples/disk-health.sh # Disk temperatures & health

./examples/read-logs.sh syslog 20 # Read system logs

```

Core Concepts

GraphQL API Structure

Unraid 7.2+ uses GraphQL (not REST). Key differences:

Two Resources for Stats

Always use `metrics` for monitoring, `info` for specifications.

Common Tasks

System Monitoring

**Check if server is online:**

```bash

./scripts/unraid-query.sh -q "{ online }"

```

**Get CPU and memory usage:**

```bash

./scripts/unraid-query.sh -q "{ metrics { cpu { percentTotal } memory { used total percentTotal } } }"

```

**Complete dashboard:**

```bash

./scripts/dashboard.sh

```

Disk Management

**Check disk health and temperatures:**

```bash

./examples/disk-health.sh

```

**Get array status:**

```bash

./scripts/unraid-query.sh -q "{ array { state parityCheckStatus { status progress errors } } }"

```

**List all physical disks (including cache/USB):**

```bash

./scripts/unraid-query.sh -q "{ disks { name } }"

```

Storage Shares

**List network shares:**

```bash

./scripts/unraid-query.sh -q "{ shares { name comment } }"

```

Logs

**List available logs:**

```bash

./scripts/unraid-query.sh -q "{ logFiles { name size modifiedAt } }"

```

**Read log content:**

```bash

./examples/read-logs.sh syslog 20

```

Containers & VMs

**List Docker containers:**

```bash

./scripts/unraid-query.sh -q "{ docker { containers { names image state status } } }"

```

**List VMs:**

```bash

./scripts/unraid-query.sh -q "{ vms { name state cpus memory } } }"

```

**Note:** Container output logs are NOT accessible via API. Use `docker logs` via SSH.

Notifications

**Get notification counts:**

```bash

./scripts/unraid-query.sh -q "{ notifications { overview { unread { info warning alert total } } } }"

```

Helper Script Usage

The `scripts/unraid-query.sh` helper supports:

```bash

Basic usage

./scripts/unraid-query.sh -u URL -k API_KEY -q "QUERY"

Use environment variables

export UNRAID_URL="https://unraid.local/graphql"

export UNRAID_API_KEY="your-key"

./scripts/unraid-query.sh -q "{ online }"

Format options

-f json # Raw JSON (default)

-f pretty # Pretty-printed JSON

-f raw # Just the data (no wrapper)

```

Additional Resources

Reference Files

For detailed documentation, consult:

Helper Scripts

Quick Command Reference

```bash

System status

./scripts/unraid-query.sh -q "{ online metrics { cpu { percentTotal } } }"

Disk health

./examples/disk-health.sh

Array status

./scripts/unraid-query.sh -q "{ array { state } }"

Read logs

./examples/read-logs.sh syslog 20

Complete dashboard

./scripts/dashboard.sh

List shares

./scripts/unraid-query.sh -q "{ shares { name } }"

List containers

./scripts/unraid-query.sh -q "{ docker { containers { names state } } }"

```