跳到主要内容

欢迎使用 Unraid API

What's 新

从 Unraid OS v7.2 开始，API 集成在操作系统中，无需安装插件！

Unraid API 提供了一个 GraphQL 接口，用于程序化地与您的 Unraid 服务器进行交互。它支持自动化、监控和集成功能。

📦 可用性​

✨ 本地集成 (Unraid OS v7.2+)​

从 Unraid OS v7.2 开始，API 直接集成在操作系统中：

  • 无需安装插件
  • 系统启动时自动可用
  • 深度系统集成
  • 通过 设置 → 管理访问 → API 进行访问

🔌 插件安装（适用于 v7.2 前版本和高级用户）​

对于 Unraid v7.2 之前的版本或想获取较新 API 功能：

  1. 从社区应用安装 Unraid Connect 插件
  2. 配置插件
  3. 通过 GraphQL 沙盒 访问 API 功能
Important 笔记
  • Unraid Connect 插件为 v7.2 之前的版本提供 API
  • 您不需要登录 Unraid Connect 即可在本地使用 API
  • 在 7.2 版本上安装插件可在相关功能包含于系统发布前获取较新 API 功能

📚 文档章节​

所有 CLI 命令的完整参考

学习如何与 GraphQL API 互动

配置 SSO 认证提供商

查看即将发布的内容

🌟 关键功能​

Core 功能

API 提供了：

  • GraphQL 接口：现代、灵活的 API，具有强类型
  • 认证：包括 API 密钥、会话 cookie 和 SSO/OIDC 多种方法
  • 综合覆盖：访问系统信息、阵列管理和 Docker 操作
  • 开发者工具：内置 GraphQL 沙盒，可通过 Web 端或 CLI 配置
  • 基于角色的访问：细粒度的权限控制
  • Web 管理：通过 Web 界面管理 API 密钥和设置

🚀 开始使用​

  1. API 已安装并正在运行
  2. 在 设置 → 管理访问 → API 中访问设置
  3. 启用 GraphQL 沙盒进行开发
  4. 创建您的第一个 API 密钥
  5. 开始进行 GraphQL 查询！

有关详细使用说明，参见 CLI 命令 参考。