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

Unraid API へようこそ

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

Unraid API は、Unraid サーバーとプログラムから連携するための GraphQL インターフェースを提供します。複数の認証方式(API キー、セッション Cookie、SSO/OIDC)を備えた、最新の強力な型付けがされた API により、自動化、監視、統合機能を実現し、システム全体を包括的にカバーし、開発者向けツールも組み込まれています。

提供状況

ネイティブ統合(Unraid 7.2+)

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

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

プラグインのインストール(7.2 未満および上級ユーザー向け)

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

  1. Community Applications から Unraid Connect プラグインをインストールします。
  2. プラグインを設定します
  3. GraphQL サンドボックスを通じて API 機能にアクセスします。

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

始める

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

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