Workspaces

A Workspace is a lightweight way to organize related resources inside a single Files.com Site.

Customers commonly group resources by project, department, client, or region. Workspaces provide a built-in structure for that grouping, so the UI can operate within a clear “workspace context” and admins can delegate management for a subset of resources without requiring full site-level isolation.

Every Site has an implicit Default workspace (ID 0). Resources that are not explicitly assigned to a named workspace are considered part of the Default workspace.

List Workspaces

Command

files-cli workspaces list

Output

Outputs a list of Workspace objects according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Additional Arguments

Example Request

files-cli workspaces list

Show Workspace

Command

files-cli workspaces find

Output

Outputs a Workspace object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required		Workspace ID.

Example Request

files-cli workspaces find \
  --id=1

Create Workspace

Command

files-cli workspaces create

Output

Outputs a Workspace object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--name=
string		Workspace name

Example Request

files-cli workspaces create \
  --name="Project Alpha"

Update Workspace

Command

files-cli workspaces update

Output

Outputs a Workspace object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required		Workspace ID.
--name=
string		Workspace name

Example Request

files-cli workspaces update \
  --id=1 \
  --name="Project Alpha"

Delete Workspace

Command

files-cli workspaces delete

Output

No output is returned.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required		Workspace ID.

Example Request

files-cli workspaces delete \
  --id=1

The Workspace Object

Some of the commands above return a Workspace object. The attributes of this object are listed below.

AttributeDescription
id
int64		Workspace ID
name
string		Workspace name