Pular para o conteúdo principal

Recursos

Todo recurso de dashboards abaixo é gerado a partir da mesma spec OpenAPI documentada na Referência da API — o CLI chama exatamente os mesmos endpoints, então filtros, validação e permissões são idênticos. Recorra à introspecção de schema sempre que os parâmetros exatos de um comando não estiverem óbvios nos exemplos destas páginas.

kobana dashboards <recurso> <metodo> [flags]

Como ler estas páginas​

--params carrega parâmetros de query, de caminho e de cabeçalho (id, página, filtros, X-Workspace-Id); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa. Quase todo recurso age sobre um workspace: veja em Autenticação como escolher qual.

Nomes aninhados viram palavras: entities records list chama GET /v1/entities/{id}/records. A coluna HTTP de cada página mostra o caminho real — o único lugar em que a versão da API aparece.

RecursoComandoMétodos
Fontes de dadosdata-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
Entidadesentitieslist, 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
Construtor do portalbuilderlist, 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
Configurações do portalportal-settingslist, update, domain update, domain check-slug list, logo create, logo delete, sender-identity create
Domínios própriosportal-custom-domainslist, create, delete, dns-status, verify
Provedores OIDCportal-oauth-providerslist, create, update, delete, test create
Usuários do portalportal-userslist, create, get, update, delete, email-preview, resend, activity get, activity timeline list, invite create
Mapeamento de usuários do portalportal-user-mappingslist, update, delete
Checklistschecklistslist, get, progress get, progress update, progress delete, progress file get, progress file create, progress file delete
Comentárioscommentslist, create, get, delete
Arquivosassetslist, create, get, update, delete, download, presign create
Tipos de arquivoasset-typeslist, create, get, update, delete
Modelos de e-mailemail-templateslist, create, get, update, delete, duplicate, init-defaults create, preview get, preview create
Layouts de e-mailemail-layoutslist, create, get, update, delete, init-defaults create
Notificaçõesnotificationslist, create, send, stats list
Webhookswebhookslist, create, get, update, delete, rotate-secret, test, deliveries retry, deliveries list
Entregas de webhookwebhook-deliverieslist, get
Eventoseventslist, get
Chaves de APIapi-keyslist, create, get, update, delete, revoke, rotate
Membrosdashboard-userslist, create, update, get, delete, resend, workspaces get, workspaces update
Funçõesteam-roleslist, create, update, get, delete
Permissõespermissionslist
Organizaçãoorganizationlist, update
Configuraçõessettingslist, update
Identidade do tokenmelist
Consumousagelist
Uso de IAai-usagelist
Limites de requisiçãorate-limitslist
Auditoriaaudit-logslist, get, summary list
Exportaçõesexportslist, create, get, download
Importaçõesimportslist, create, get
Backupsbackupslist, create, get, delete, cancel, download, restore create
Limpeza de dadosdata-purgeslist, delete, get
Manutençãomaintenanceuppercase-names create