unraid-mcp/skills/unraid/references/quick-reference.md

Unraid API Quick Reference

Quick reference for the most common Unraid GraphQL API queries.

Setup

# Set environment variables
export UNRAID_URL="https://your-unraid-server/graphql"
export UNRAID_API_KEY="your-api-key-here"

# Or use the helper script directly
./scripts/unraid-query.sh -u "$UNRAID_URL" -k "$UNRAID_API_KEY" -q "{ online }"

Common Queries

System Status

{ 
  online 
  metrics { 
    cpu { percentTotal } 
    memory { total used free percentTotal } 
  } 
}

Array Status

{ 
  array { 
    state 
    parityCheckStatus { status progress errors } 
  } 
}

Disk List with Temperatures

{ 
  array { 
    disks { 
      name 
      device 
      temp 
      status 
      fsSize 
      fsFree 
      isSpinning 
    } 
  } 
}

All Physical Disks (including USB/SSDs)

{ 
  disks { 
    id 
    name 
  } 
}

Network Shares

{ 
  shares { 
    name 
    comment 
  } 
}

Docker Containers

{ 
  docker { 
    containers { 
      id 
      names 
      image 
      state 
      status 
    } 
  } 
}

Virtual Machines

{ 
  vms { 
    id 
    name 
    state 
    cpus 
    memory 
  } 
}

List Log Files

{ 
  logFiles { 
    name 
    size 
    modifiedAt 
  } 
}

Read Log Content

{ 
  logFile(path: "syslog", lines: 20) { 
    content 
    totalLines 
  } 
}

System Info

{ 
  info { 
    time 
    cpu { model cores threads } 
    os { distro release } 
    system { manufacturer model } 
  } 
}

UPS Devices

{ 
  upsDevices { 
    id 
    name 
    status 
    charge 
    load 
  } 
}

Notifications

Counts:

{ 
  notifications { 
    overview { 
      unread { info warning alert total } 
      archive { info warning alert total } 
    } 
  } 
}

List Unread:

{ 
  notifications { 
    list(filter: { type: UNREAD, offset: 0, limit: 10 }) { 
      id 
      subject 
      description 
      timestamp 
    } 
  } 
}

List Archived:

{ 
  notifications { 
    list(filter: { type: ARCHIVE, offset: 0, limit: 10 }) { 
      id 
      subject 
      description 
      timestamp 
    } 
  } 
}

Field Name Notes

• Use metrics for real-time usage (CPU/memory percentages)
• Use info for hardware specs (cores, model, etc.)
• Temperature field is temp (not temperature)
• Status field is state for array (not status)
• Sizes are in kilobytes
• Temperatures are in Celsius

Response Structure

All responses follow this pattern:

{
  "data": {
    "queryName": { ... }
  }
}

Errors appear in:

{
  "errors": [
    { "message": "..." }
  ]
}