Skip to main content

Manual

The manual lists all the commands of kobana: what each one does, the HTTP method and path, the parameters, the request body and the responses. It is generated from the binary itself — --help, kobana schema and the embedded OpenAPI specifications — so it follows every version and every language.

kobana <product> <resource> <method> [flags]

CLI commands​

CommandWhat for
Global optionsThe flags every command accepts: --params, --json, --fields, --dry-run…
kobana schemaParameters, body and responses of an endpoint
kobana completionsCompletion for bash, zsh, fish, PowerShell and elvish
kobana updateChecks for a new version and updates the CLI

Products​

ProductCommand
Banking Gatewaykobana banking
Smart Financekobana finance
Automatic Billingkobana billing
Autonomous Inboxkobana inbox
Dunningkobana dunning
Magic Dashboardkobana dashboards
Kadu Agentkobana kadu

Each product has one page per resource, with one section per command.

How to read a page​

  • The text block is the usage line, as --help prints it. [ID] are the path identifiers, in route order; [OPTIONS], the global options.
  • GET /v1/… is the call the command makes. The API version appears only there — never in the command.
  • Query parameters, headers and body go in --params and --json. The Required column says what the API demands.
  • Request body shows the first-level fields. For nested objects, run the kobana schema command indicated on the page.

Errors common to all commands​

All endpoints can respond with these codes, which the manual does not repeat on each command:

HTTPMeaning
401Token missing, invalid or expired — see Authentication
403Valid token, but without permission (or without the required access level) for the operation
429Request limit exceeded
500Unexpected server error

In the CLI, a 4xx or 5xx response ends with exit code 1.