nb api ダイナミックコマンド

nb api resource 以外に、nb api には NocoBase アプリケーションの OpenAPI Schema から動的に生成されるコマンドがあります。これらのコマンドは nb env add または nb env update を初めて実行した際に生成・キャッシュされます。

一般的なグループ

コマンドグループ説明
nb api acl権限管理:ロール、リソース権限、操作権限
nb api api-keysAPI Key 管理
nb api appアプリケーション管理
nb api authenticators認証管理:パスワード、SMS、SSO など
nb api data-modelingデータモデリング:データソース、データテーブル、フィールド
nb api file-managerファイル管理:ストレージサービスと添付ファイル
nb api flow-surfacesページ構成:ページ、ブロック、フィールド、操作
nb api system-settingsシステム設定:タイトル、Logo、言語など
nb api theme-editorテーマ管理:カラー、サイズ、テーマ切り替え
nb api workflowワークフロー:自動化プロセス管理

実際に利用可能なグループとコマンドは、接続先の NocoBase アプリケーションのバージョンと有効なプラグインによって異なります。現在のアプリケーションがサポートするコマンドを確認するには、以下を実行してください:

nb api --help
nb api <topic> --help

リクエストボディパラメータ

リクエストボディを伴うダイナミックコマンドでは以下をサポートしています:

パラメータ説明
--bodystringJSON 文字列形式のリクエストボディ
--body-filestringJSON ファイルのパス

--body--body-file は排他的です。

動的 API コマンドでは、次のオプションも利用できます。

  • --env, -e: リクエストを送信する CLI env 名です。省略すると現在の env が使われます
  • --yes, -y: 明示的に指定した --env が現在の env と異なる場合、対話確認をスキップします

--env を明示的に指定し、その値が現在の env と異なる場合、CLI は最初に確認を求めます。非対話端末や AI エージェントのセッションでは、自分で --yes を追加するか、先に nb env use <name> を実行してから再試行してください。

関連コマンド