Portal builder

The workspace's portal builder: the draft, the published versions and the theme. list returns the full state (including the revision that guards saving), draft update replaces the whole draft and publish create puts it live as a new version. The tools commands edit the draft piece by piece — a page, a block, a field — and are the same ones the builder's AI chat uses.

Draft, publishing and theme

Command	HTTP	Description
builder list	GET /v1/builder	Get the portal builder
builder draft update	PUT /v1/builder/draft	Save the portal draft
builder og-image create	POST /v1/builder/og_image	Upload an og:image
builder publish create	POST /v1/builder/publish	Publish the portal
builder secrets create	POST /v1/builder/secrets	Seal a block secret
builder theme update	PATCH /v1/builder/theme	Update the portal theme colors

Testing the draft

They really run the action of a draft Action button or Form, flagged as preview: true.

Command	HTTP	Description
builder action-runs create	POST /v1/builder/action_runs	Test a draft action button
builder form-submissions create	POST /v1/builder/form_submissions	Test a draft form

Versions

versions restore copies a version into the draft without touching what is live; versions rollback puts the version back live right away.

Command	HTTP	Description
builder versions get	GET /v1/builder/versions/{number}	Get a published version
builder versions restore	POST /v1/builder/versions/{number}/restore	Restore a version into the draft
builder versions rollback	POST /v1/builder/versions/{number}/rollback	Roll back to a version

Tools — pages

Command	HTTP	Description
builder tools create-page create	POST /v1/builder/tools/create_page	Create a page
builder tools delete-page create	POST /v1/builder/tools/delete_page	Delete a page
builder tools get-page list	GET /v1/builder/tools/get_page	Get a draft page
builder tools list-pages list	GET /v1/builder/tools/list_pages	List the draft pages
builder tools move-page create	POST /v1/builder/tools/move_page	Move a page in the menu
builder tools update-page create	POST /v1/builder/tools/update_page	Update a page

Tools — blocks

Command	HTTP	Description
builder tools describe-block-type list	GET /v1/builder/tools/describe_block_type	Describe a block type
builder tools duplicate-block create	POST /v1/builder/tools/duplicate_block	Duplicate a block
builder tools insert-block create	POST /v1/builder/tools/insert_block	Insert a block
builder tools list-actions list	GET /v1/builder/tools/list_actions	List button actions
builder tools list-block-types list	GET /v1/builder/tools/list_block_types	List block types
builder tools move-block create	POST /v1/builder/tools/move_block	Move a block
builder tools remove-block create	POST /v1/builder/tools/remove_block	Remove a block
builder tools update-block create	POST /v1/builder/tools/update_block	Update a block

Tools — theme, files and entities

Command	HTTP	Description
builder tools get-theme list	GET /v1/builder/tools/get_theme	Get the theme colors
builder tools preview-portal-user-mapping list	GET /v1/builder/tools/preview_portal_user_mapping	Preview the portal user mapping
builder tools read-asset list	GET /v1/builder/tools/read_asset	Read the content of a file
builder tools register-entity create	POST /v1/builder/tools/register_entity	Register an entity from a data source
builder tools rename-entity-fields create	POST /v1/builder/tools/rename_entity_fields	Rename the fields of an entity
builder tools save-computed-field create	POST /v1/builder/tools/save_computed_field	Save a computed field

Examples

--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.

# Get the portal builder
kobana dashboards builder list --fields "draft,live_version,versions"

# List the draft pages
kobana dashboards builder tools list-pages list

# Create a page
kobana dashboards builder tools create-page create \
  --json '{"name": "Faturas", "template": "list", "entity": "faturas"}'

# Insert a block
kobana dashboards builder tools insert-block create \
  --json '{"page_id": "PAGE_ID", "type": "Text", "props": {"text": "Bem-vindo!"}}'

# Publish the portal
kobana dashboards builder publish create \
  --json '{"revision": 12, "pages": [], "note": "Nova página de faturas"}' \
  --dry-run

# Roll back to a version
kobana dashboards builder versions rollback --params '{"number": 3}' --dry-run

Next steps

• Portal settings
• Entities
• Schema introspection — every parameter this resource accepts.