Welcome to Unraid API
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:
- Install Unraid Connect Plugin from Apps
- Configure the plugin
- Access API functionality through the GraphQL Sandbox
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β
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β
- Access the API settings at Settings β Management Access β API
- Enable the GraphQL Sandbox for development
- Create your first API key
- Start making GraphQL queries!
- Install the Unraid Connect plugin from Apps
- Configure the plugin settings
- Enable the GraphQL Sandbox
- Start exploring the API!
For detailed usage instructions, see the CLI Commands reference.