Skip to main content

Welcome to Unraid API

What's New

Starting with Unraid OS v7.2, the API comes built into the operating system - no plugin installation required!

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 OS v7.2+)​

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

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

πŸ”Œ Plugin Installation (Pre-7.2 and Advanced Users)​

For Unraid versions prior to v7.2 or to access newer API features:

  1. Install the Unraid Connect Plugin from Community Apps
  2. Configure the plugin
  3. Access API functionality through the GraphQL Sandbox
Important Notes
  • The Unraid Connect plugin provides the API for pre-7.2 versions
  • You do NOT need to sign in to Unraid Connect to use the API locally
  • Installing the plugin on 7.2+ gives you access to newer API features before they're included in OS releases

πŸ“š Documentation Sections​

🌟 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. The API is already installed and running
  2. Access settings at Settings β†’ Management Access β†’ API
  3. Enable the GraphQL Sandbox for development
  4. Create your first API key
  5. Start making GraphQL queries!

For detailed usage instructions, see the CLI Commands reference.