Skip to main content

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​

ResourceCommandMethods
Data sourcesdata-sourceslist, 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
Entitiesentitieslist, 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
Workspacesworkspaceslist, create, get, update, delete, export, usage, import create
Portal builderbuilderlist, 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 settingsportal-settingslist, update, domain update, domain check-slug list, logo create, logo delete, sender-identity create
Custom domainsportal-custom-domainslist, create, delete, dns-status, verify
OIDC providersportal-oauth-providerslist, create, update, delete, test create
Portal usersportal-userslist, create, get, update, delete, email-preview, resend, activity get, activity timeline list, invite create
Portal user mappingportal-user-mappingslist, update, delete
Checklistschecklistslist, get, progress get, progress update, progress delete, progress file get, progress file create, progress file delete
Commentscommentslist, create, get, delete
Assetsassetslist, create, get, update, delete, download, presign create
Asset typesasset-typeslist, create, get, update, delete
Email templatesemail-templateslist, create, get, update, delete, duplicate, init-defaults create, preview get, preview create
Email layoutsemail-layoutslist, create, get, update, delete, init-defaults create
Notificationsnotificationslist, create, send, stats list
Webhookswebhookslist, create, get, update, delete, rotate-secret, test, deliveries retry, deliveries list
Webhook deliverieswebhook-deliverieslist, get
Eventseventslist, get
API keysapi-keyslist, create, get, update, delete, revoke, rotate
Membersdashboard-userslist, create, update, get, delete, resend, workspaces get, workspaces update
Rolesteam-roleslist, create, update, get, delete
Permissionspermissionslist
Organizationorganizationlist, update
Settingssettingslist, update
Token identitymelist
Usageusagelist
AI usageai-usagelist
Rate limitsrate-limitslist
Audit logsaudit-logslist, get, summary list
Exportsexportslist, create, get, download
Importsimportslist, create, get
Backupsbackupslist, create, get, delete, cancel, download, restore create
Data purgedata-purgeslist, delete, get
Maintenancemaintenanceuppercase-names create