Skip to main content

Workspaces

Business domains of the organization. Each workspace is a plugin of the Kadu Playbook.

CommandHTTPDescription
workspaces listGET /v1/workspacesList workspaces
workspaces createPOST /v1/workspacesCreate workspace
workspaces getGET /v1/workspaces/{id}Get workspace details
workspaces updatePATCH /v1/workspaces/{id}Update workspace
workspaces deleteDELETE /v1/workspaces/{id}Delete workspaces (soft delete)

Examples​

--params carries query and path parameters (id, page, filters); --json carries the request body; --fields limits the fields that come back — worth using on every list/get to save context. See Global flags for the full reference.

# List workspaces
kobana kadu workspaces list --fields "id"

# Create workspace
kobana kadu workspaces create --json '{"label": "LABEL"}'

# Get workspace details
kobana kadu workspaces get --params '{"id": "WORKSPACE_ID"}'

# Update workspace
kobana kadu workspaces update --params '{"id": "WORKSPACE_ID"}'

# Delete workspaces (soft delete)
kobana kadu workspaces delete \
--params '{"id": "WORKSPACE_ID"}' \
--dry-run

Next steps​