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

CLIコマンド

すべてのコマンドは次のパターンに従います: unraid-api <command> [options]

サービス管理​

開始​

unraid-api start [--log-level <level>]

Unraid API サービスを開始します。

オプション:

  • --log-level: ログレベルを設定します (trace|debug|info|warn|error|fatal)

代替: LOG_LEVEL 環境変数を使用してログレベルを設定することもできます:

LOG_LEVEL=trace unraid-api start

停止​

unraid-api stop [--delete]

Unraid API サービスを停止します。

  • --delete: 任意。PM2 ホームディレクトリを削除します。

再起動​

unraid-api restart [--log-level <level>]

Unraid API サービスを再起動します。

オプション:

  • --log-level: ログレベルを設定します (trace|debug|info|warn|error|fatal)

代替: LOG_LEVEL 環境変数を使用してログレベルを設定することもできます:

LOG_LEVEL=trace unraid-api restart

ログ​

unraid-api logs [-l <lines>]

API ログを表示します。

  • -l, --lines: 任意。追跡する行数 (既定値: 100)

設定コマンド​

構成​

unraid-api config

現在の構成値を表示します。

環境を切り替える​

unraid-api switch-env [-e <environment>]

production と staging の環境を切り替えます。

  • -e, --environment: 任意。対象環境 (production|staging)。

開発者モード​

WebGUI の Settings → Management Access → Developer Options にある Web インターフェースからも、開発者オプションを管理できます。

unraid-api developer                       # Interactive prompt for tools
unraid-api developer --sandbox true        # Enable %%GraphQL|graphql%% sandbox
unraid-api developer --sandbox false       # Disable %%GraphQL|graphql%% sandbox
unraid-api developer --enable-modal        # Enable modal testing tool
unraid-api developer --disable-modal       # Disable modal testing tool

API 用の開発者機能を設定します:

  • GraphQL サンドボックス: /graphql で Apollo GraphQL サンドボックスを有効/無効にします
  • モーダルテストツール: Unraid メニューで UI モーダルのテストを有効/無効にします

API キー管理​

WebGUI の Settings → Management Access → API Keys にある Web インターフェースからも、API キーを管理できます。

API キーコマンド​

unraid-api apikey [options]

CLI を使って API キーを作成および管理します。

オプション:

  • --name <name>: キーの名前
  • --create: 新しいキーを作成します
  • -r, --roles <roles>: カンマ区切りのロール一覧
  • -p, --permissions <permissions>: カンマ区切りの権限一覧
  • -d, --description <description>: キーの説明

SSO (シングルサインオン) 管理​

OIDC/SSO プロバイダーの構成については、WebGUI の Settings → Management Access → API → OIDC にある Web インターフェースを参照するか、OIDC Provider Setup ガイドを参照してください。

SSO ベースコマンド​

unraid-api sso

オプション:

unraid-api sso add-user
# or
unraid-api sso add
# or
unraid-api sso a

SSO ユーザーを削除:

unraid-api sso remove-user
# or
unraid-api sso remove
# or
unraid-api sso r

OIDC/SSO プロバイダーの構成については、Web インターフェースの Settings → Management Access → API → OIDC を参照するか、OIDC Provider Setup ガイドを参照してください。

unraid-api sso list-users
# or
unraid-api sso list
# or
unraid-api sso l

SSO トークンを検証:

SSO トークンを検証し、その状態を返します。

unraid-api sso validate-token <token>
# or
unraid-api sso validate
# or
unraid-api sso v

レポート生成​

SSO ユーザーを削除​

unraid-api report [-r] [-j]

システムレポートを生成します。

  • -r, --raw: 生のコマンド出力を表示します
  • -j, --json: 出力を JSON 形式で表示します

ほとんどのコマンドでは、システム状態を変更するために適切な権限が必要です。一部のコマンドでは、API が実行中または停止中である必要があります。API キーはシステムアクセスを提供するため、安全に保管してください。SSO の構成変更には、サービスの再起動が必要な場合があります。