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:
- Install the Unraid Connect Plugin from Community Apps
- Configure the plugin
- 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β
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β
- The API is already installed and running
- Access 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 Community Apps
- No Unraid Connect login required for local API access
- Configure the plugin settings
- Enable the GraphQL Sandbox
- Start exploring the API!
For detailed usage instructions, see the CLI Commands reference.