Skip to main content

Welcome to Unraid API

What's New

Native integration in Unraid v7.2+ brings the API directly into the OS - no plugin needed!

The Unraid API provides a GraphQL interface for programmatic interaction with your Unraid server. It enables automation, monitoring, and integration capabilities.

πŸ“¦ Availability​

✨ Native Integration (Unraid v7.2-beta.1+)​

Starting with Unraid v7.2-beta.1, the API is integrated directly into the Unraid operating system:

  • No plugin installation required
  • Automatically available on system startup
  • Deep system integration
  • Access through Settings β†’ Management Access β†’ API

πŸ”Œ Plugin Installation (Earlier Versions)​

For Unraid versions prior to v7.2:

  1. Install Unraid Connect Plugin from Apps
  2. Configure the plugin
  3. Access API functionality through the GraphQL Sandbox
Pre-release Versions

You can install the Unraid Connect plugin on any version to access pre-release versions of the API and get early access to new features before they're included in Unraid OS releases.

πŸ“š Documentation Sections​

Complete reference for all CLI commands

Learn how to interact with the GraphQL API

Configure SSO authentication providers

See what's coming next

🌟 Key Features​

Core Capabilities

The API provides:

  • GraphQL Interface: Modern, flexible API with strong typing
  • Authentication: Multiple methods including API keys, session cookies, and SSO/OIDC
  • Comprehensive Coverage: Access to system information, array management, and Docker operations
  • Developer Tools: Built-in GraphQL sandbox configurable via web interface or CLI
  • Role-Based Access: Granular permission control
  • Web Management: Manage API keys and settings through the web interface

πŸš€ Get Started​

  1. Access the API settings at Settings β†’ Management Access β†’ API
  2. Enable the GraphQL Sandbox for development
  3. Create your first API key
  4. Start making GraphQL queries!
  1. Install the Unraid Connect plugin from Apps
  2. Configure the plugin settings
  3. Enable the GraphQL Sandbox
  4. Start exploring the API!

For detailed usage instructions, see the CLI Commands reference.