mirror/api
1
0
Fork 0
mirror of https://github.com/unraid/api.git synced 2026-01-04 07:29:48 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: update API documentation for Unraid OS v7.2 integration

Browse Source 
- Revised language to clarify that the API is built into Unraid OS v7.2 and does not require plugin installation.
- Updated sections for earlier versions to reflect the Unraid Connect plugin's role and access to newer API features.
- Enhanced clarity in the "Get Started" section with step-by-step instructions for both v7.2 and pre-7.2 users.
This commit is contained in:
Eli Bosley
2025-08-20 15:13:06 -04:00
parent 26aeca3624
commit 335f949b53
1 changed files with 22 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
api/docs/public/index.md
View File

@@ -7,32 +7,34 @@ sidebar_position: 1
# Welcome to Unraid API
:::tip[What's New]
Native integration in Unraid v7.2+ brings the API directly into the OS - no plugin needed!
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 v7.2-beta.1+)
### ✨ Native Integration (Unraid OS v7.2+)
Starting with Unraid v7.2-beta.1, the API is integrated directly into the Unraid operating system:
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 (Earlier Versions)
### 🔌 Plugin Installation (Pre-7.2 and Advanced Users)
For Unraid versions prior to v7.2:
For Unraid versions prior to v7.2 or to access newer API features:
1. Install Unraid Connect Plugin from Apps
1. Install the Unraid Connect Plugin from Community Apps
2. [Configure the plugin](./how-to-use-the-api.md#enabling-the-graphql-sandbox)
3. Access API functionality through the [GraphQL Sandbox](./how-to-use-the-api.md)
:::tip 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.
:::info 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
@@ -69,20 +71,22 @@ The API provides:
## 🚀 Get Started
<tabs>
<tabItem value="v72" label="Unraid v7.2+" default>
<tabItem value="v72" label="Unraid OS v7.2+" default>
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. 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!
</tabItem>
<tabItem value="older" label="Earlier Versions">
<tabItem value="older" label="Pre-7.2 Versions">
1. Install the Unraid Connect plugin from Apps
2. Configure the plugin settings
3. Enable the GraphQL Sandbox
4. Start exploring the API!
1. Install the Unraid Connect plugin from Community Apps
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!
</tabItem>
</tabs>