跳到主要内容

欢迎使用 Unraid API

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

Unraid API 提供一个 GraphQL 接口,用于以编程方式与您的 Unraid 服务器交互。它通过一个现代、强类型的 API,支持多种身份验证方式(API 密钥、会话 Cookie 以及 SSO/OIDC)、全面的系统覆盖以及内置的开发者工具,从而实现自动化、监控和集成功能。

可用性

本地集成(Unraid 7.2+)

从 Unraid 7.2 开始,API 直接集成到操作系统中:

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

插件安装(适用于 7.2 之前版本和高级用户)

对于 7.2 之前的 Unraid 版本,或者要访问更新的 API 功能:

  1. Community Applications 安装 Unraid Connect 插件。
  2. 配置插件.
  3. 通过 GraphQL Sandbox 访问 API 功能。

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

开始使用

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

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