nb api Dynamische Befehle

Neben nb api resource gibt es unter nb api eine Reihe von Befehlen, die dynamisch anhand des OpenAPI-Schemas der NocoBase-Anwendung generiert werden. Diese Befehle werden beim ersten Ausführen von nb env add oder nb env update erzeugt und zwischengespeichert.

Häufige Gruppen

BefehlsgruppeBeschreibung
nb api aclBerechtigungsverwaltung: Rollen, Ressourcenberechtigungen und Aktionsberechtigungen
nb api api-keysAPI-Key-Verwaltung
nb api appAnwendungsverwaltung
nb api authenticatorsAuthentifizierungsverwaltung: Passwort, SMS, SSO usw.
nb api data-modelingDatenmodellierung: Datenquellen, Tabellen und Felder
nb api file-managerDateiverwaltung: Speicherdienste und Anhänge
nb api flow-surfacesSeiten-Orchestrierung: Seiten, Blöcke, Felder und Aktionen
nb api system-settingsSystemeinstellungen: Titel, Logo, Sprache usw.
nb api theme-editorTheme-Verwaltung: Farben, Größen und Theme-Wechsel
nb api workflowWorkflow: Verwaltung automatisierter Abläufe

Welche Gruppen und Befehle tatsächlich verfügbar sind, hängt von der Version der verbundenen NocoBase-Anwendung und den aktivierten Plugins ab. Führen Sie folgende Befehle aus, um die in der aktuellen Anwendung unterstützten Befehle anzuzeigen:

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

Request-Body-Parameter

Dynamische Befehle mit Request-Body unterstützen:

ParameterTypBeschreibung
--bodystringRequest-Body als JSON-Zeichenkette
--body-filestringPfad zu einer JSON-Datei

--body und --body-file schließen sich gegenseitig aus.

Dynamische API-Befehle unterstützen außerdem:

  • --env, -e: Name der CLI-env, an die die Anfrage gesendet werden soll; wenn weggelassen, wird die aktuelle env verwendet
  • --yes, -y: Wenn ein explizit übergebenes --env auf eine andere env als die aktuelle env zeigt, die interaktive Bestätigung überspringen

Wenn Sie --env explizit übergeben und es sich von der aktuellen env unterscheidet, fragt die CLI zuerst nach einer Bestätigung. In nicht interaktiven Terminals oder AI-Agent-Sitzungen fügen Sie --yes selbst hinzu oder führen zuerst nb env use <name> aus und versuchen es dann erneut.

Verwandte Befehle