Resources
Every dashboards resource below is generated from the same OpenAPI spec documented in the API Reference — the CLI calls exactly the same endpoints, so filtering, validation and permissions are identical. Fall back on schema introspection whenever a command's exact parameters are not obvious from the examples on these pages.
kobana dashboards <resource> <method> [flags]
How to read these pages
--params carries query, path and header parameters (id, page, filters, X-Workspace-Id); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference. Almost every resource acts on a workspace: see Authentication for how to choose which.
Nested names become words: entities records list calls GET /v1/entities/{id}/records. The HTTP column on each page shows the real path — the only place the API version appears.
The catalogue
| Resource | Command | Methods |
|---|---|---|
| Data sources | data-sources | list, get, update, delete, authorize, schedule, spec, sync, catalog list, catalog create, database create, logs list, logs get, mcp create, openapi create, openapi analyze create, operations update, test create |
| Entities | entities | list, create, get, update, delete, aggregate, usage, join create, join update, join preview create, logs list, logs get, preview create, records list, records get, records create, records delete, records import create, sync get, sync create, tenant-syncs list, tenant-syncs create |
| Workspaces | workspaces | list, create, get, update, delete, export, usage, import create |
| Portal builder | builder | list, action-runs create, draft update, form-submissions create, og-image create, publish create, secrets create, theme update, tools create-page create, tools delete-page create, tools describe-block-type list, tools duplicate-block create, tools get-page list, tools get-theme list, tools insert-block create, tools list-actions list, tools list-block-types list, tools list-pages list, tools move-block create, tools move-page create, tools preview-portal-user-mapping list, tools read-asset list, tools register-entity create, tools remove-block create, tools rename-entity-fields create, tools save-computed-field create, tools update-block create, tools update-page create, versions get, versions restore, versions rollback |
| Portal settings | portal-settings | list, update, domain update, domain check-slug list, logo create, logo delete, sender-identity create |
| Custom domains | portal-custom-domains | list, create, delete, dns-status, verify |
| OIDC providers | portal-oauth-providers | list, create, update, delete, test create |
| Portal users | portal-users | list, create, get, update, delete, email-preview, resend, activity get, activity timeline list, invite create |
| Portal user mapping | portal-user-mappings | list, update, delete |
| Checklists | checklists | list, get, progress get, progress update, progress delete, progress file get, progress file create, progress file delete |
| Comments | comments | list, create, get, delete |
| Assets | assets | list, create, get, update, delete, download, presign create |
| Asset types | asset-types | list, create, get, update, delete |
| Email templates | email-templates | list, create, get, update, delete, duplicate, init-defaults create, preview get, preview create |
| Email layouts | email-layouts | list, create, get, update, delete, init-defaults create |
| Notifications | notifications | list, create, send, stats list |
| Webhooks | webhooks | list, create, get, update, delete, rotate-secret, test, deliveries retry, deliveries list |
| Webhook deliveries | webhook-deliveries | list, get |
| Events | events | list, get |
| API keys | api-keys | list, create, get, update, delete, revoke, rotate |
| Members | dashboard-users | list, create, update, get, delete, resend, workspaces get, workspaces update |
| Roles | team-roles | list, create, update, get, delete |
| Permissions | permissions | list |
| Organization | organization | list, update |
| Settings | settings | list, update |
| Token identity | me | list |
| Usage | usage | list |
| AI usage | ai-usage | list |
| Rate limits | rate-limits | list |
| Audit logs | audit-logs | list, get, summary list |
| Exports | exports | list, create, get, download |
| Imports | imports | list, create, get |
| Backups | backups | list, create, get, delete, cancel, download, restore create |
| Data purge | data-purges | list, delete, get |
| Maintenance | maintenance | uppercase-names create |