docs/docs/en/api/cli/api/dynamic.md
In addition to nb api resource, nb api includes commands generated from the NocoBase app's OpenAPI Schema. These commands are generated and cached the first time you run nb env add or nb env update.
| Command group | Description |
|---|---|
nb api acl | Access control: roles, resource permissions, and action permissions |
nb api api-keys | API Key management |
nb api app | App management |
nb api authenticators | Authentication management: password, SMS, SSO, and more |
nb api data-modeling | Data modeling: data sources, collections, and fields |
nb api file-manager | File management: storage services and attachments |
nb api flow-surfaces | Page orchestration: pages, blocks, fields, and actions |
nb api system-settings | System settings: title, logo, language, and more |
nb api theme-editor | Theme management: colors, sizes, and theme switching |
nb api workflow | Workflow: automation process management |
Available groups and commands depend on the connected NocoBase app version and enabled plugins. Run the following commands to inspect the commands supported by the current app:
nb api --help
nb api <topic> --help
Dynamic commands with request bodies support:
| Parameter | Type | Description |
|---|---|---|
--body | string | Request body as a JSON string |
--body-file | string | Path to a JSON file |
--body and --body-file are mutually exclusive.
Dynamic API commands also support:
--env, -e: CLI env name to send the request to; when omitted, the current env is used--yes, -y: When an explicitly passed --env targets a different env than the current env, skip the interactive confirmation promptIf you explicitly pass --env and it differs from the current env, the CLI asks for confirmation first. In non-interactive terminals or AI agent sessions, add --yes yourself or run nb env use <name> first and try again.