Welcome to Unraid API

Starting with Unraid 7.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 through a modern, strongly-typed API with multiple authentication methods (API keys, session cookies, and SSO/OIDC), comprehensive system coverage, and built-in developer tools.

Availability

Native integration (Unraid 7.2+)

Starting with Unraid 7.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 7.2, or to access newer API features:

1. Install the Unraid Connect plugin from Community Applications.
2. Configure the plugin.
3. Access API functionality through the GraphQL Sandbox.

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 Unraid 7.2+ gives you access to newer API features before they're included in OS releases.

Get started

Unraid 7.2+

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!

Pre-7.2 Versions

1. Install the Unraid Connect plugin from Community Applications.
2. No Unraid Connect login required for local API access.
3. Configure the plugin settings.
4. Enable the GraphQL Sandbox.
5. Start exploring the API!

For detailed usage instructions, see the CLI Commands reference.