Workspaces

The organization's workspaces — each with its own portal, connectors, entities and portal users. A workspace's id or public_id is what goes in the X-Workspace-Id header (see Authentication). export downloads a workspace's configuration as JSON, import create restores it into a new workspace and usage counts what deleting it would hide.

Command	HTTP	Description
`workspaces list`	`GET /v1/workspaces`	List workspaces
`workspaces create`	`POST /v1/workspaces`	Create workspace
`workspaces get`	`GET /v1/workspaces/{id}`	Get workspace
`workspaces update`	`PATCH /v1/workspaces/{id}`	Rename workspace
`workspaces delete`	`DELETE /v1/workspaces/{id}`	Delete workspace
`workspaces export`	`GET /v1/workspaces/{id}/export`	Export workspace
`workspaces usage`	`GET /v1/workspaces/{id}/usage`	Count what deleting the workspace would hide
`workspaces import create`	`POST /v1/workspaces/import`	Import workspace

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.

# List workspaces
kobana dashboards workspaces list --fields "id,public_id,name,role"

# Create workspace
kobana dashboards workspaces create --json '{"name": "Portal de clientes"}'

# Rename workspace
kobana dashboards workspaces update \
  --params '{"id": "WORKSPACE_ID"}' \
  --json '{"name": "Portal de parceiros"}'

# Export workspace
kobana dashboards workspaces export \
  --params '{"id": "WORKSPACE_ID"}' \
  --output workspace.json

# Count what deleting the workspace would hide
kobana dashboards workspaces usage --params '{"id": "WORKSPACE_ID"}'

Next steps

Members
Schema introspection — every parameter this resource accepts.

Examples​

Next steps​

Examples

Next steps