Skip to main content

Schema introspection

# List every product and its resources
kobana schema --list

# View the schema of a specific endpoint
kobana schema dashboards.data-sources.list
kobana schema dashboards.entities.records.get
kobana schema dashboards.builder.tools.insert-block.create

Returns parameters, headers (header_params, where X-Workspace-Id shows up), required fields, types and responses — all derived from the embedded OpenAPI spec, so it is always in sync with what a command actually accepts. The path has the same shape as the command, with dots instead of spaces: <product>.<resource>.<method>.

This is the recommended first step for an AI agent that does not already know the exact shape of a payload: inspect the schema before issuing a mutating call, rather than guessing.

Next steps​

  • Global flags — --params, --json, --dry-run and the rest.
  • Usage — syntax, resources, examples.