メインコンテンツへスキップ

Unraid API へようこそ

What's 新規

Unraid OS v7.2 以降では、API はオペレーティングシステムに組み込まれており、プラグインのインストールは不要です！

Unraid API は、Unraid サーバーとプログラムでやり取りするための GraphQL インターフェースを提供します。自動化、監視、統合の機能を実現します。

📦 利用可能性​

✨ ネイティブ統合（Unraid OS v7.2 以降）​

Unraid OS v7.2 以降では、API はオペレーティングシステムに直接統合されています:

  • プラグインのインストール不要
  • システム起動時に自動的に利用可能
  • システムへの深い統合
  • 設定 → 管理アクセス → API からアクセス

🔌 プラグインのインストール（v7.2 より前および上級ユーザー向け）​

Unraid v7.2 より前のバージョン、または新しい API 機能にアクセスするには:

  1. Community Apps から Unraid Connect プラグインをインストールします
  2. プラグインを設定
  3. GraphQL Sandbox を通じて API 機能にアクセスします
Important 注記
  • Unraid Connect プラグインは、v7.2 より前のバージョン向けに API を提供します
  • ローカルで API を使用するために Unraid Connect へサインインする必要はありません
  • 7.2 以降でプラグインをインストールすると、OS リリースに含まれる前の新しい API 機能にアクセスできます

📚 ドキュメントセクション​

すべての CLI コマンドの完全リファレンス

GraphQL API の操作方法を学びます

SSO 認証プロバイダーを設定します

今後の予定を見る

🌟 主な機能​

Core 機能

API は以下を提供します:

  • GraphQL インターフェース: 強力な型付けを備えた、モダンで柔軟な API
  • 認証: API キー、セッション Cookie、SSO/OIDC を含む複数の方法
  • 包括的な対応範囲: システム情報、アレイ管理、Docker 操作にアクセス
  • 開発者ツール: Web インターフェースまたは CLI から設定可能な、組み込みの GraphQL サンドボックス
  • ロールベースアクセス: 粒度の細かい権限管理
  • Web 管理: Web インターフェースから API キーと設定を管理します

🚀 はじめる​

  1. API はすでにインストールされ、実行中です
  2. 設定 → 管理アクセス → API で設定を開いてください
  3. 開発用に GraphQL Sandbox を有効にします
  4. 最初の API キーを作成します
  5. GraphQL クエリを始めましょう！

詳細な使用手順については、CLI Commands リファレンスを参照してください。