Skip to main content
This feature is in public preview.
A workspace groups resources within an account. Pools, instances, instance templates, deployments, procurements, images, subnets, and tags all belong to a workspace. Every new account comes with a workspace named default. It’s not special — it can be renamed or deleted like any other workspace.

Workspaces have to be specified

Every API request that creates, lists, or operates on workspace-scoped resources targets a workspace. Not all resources are workspace-scoped — see resource paths for which resources live at which scope.
  • Creating resources: include "workspace" in the request body
  • Listing resources: pass ?workspace= as a query parameter
  • Getting a single resource: use a resource path or an ID

Set your active workspace

If you haven’t set an active workspace, the CLI falls back to default. Set one with sf workspaces use <name>. Override per-command with --workspace <name>.

Create a workspace

List workspaces

The active workspace is marked with an arrow in the leftmost column.

View a workspace

Cross-workspace references with resource paths

Every resource has a resource path that embeds the workspace. Resource paths can be used anywhere a name or ID is accepted, enabling cross-workspace references without switching context.

Delete a workspace

Deletion fails if the workspace still contains pools, instance templates, images, or subnets. Move or delete them first.