CreateWorkspaceRequest

​

Properties

​

description?

optional description?: string

​

Description

Workspace description

---

​

name

name: string

​

Description

Workspace display name. Allowed characters are letters, digits, space, underscore, hyphen, apostrophe and ampersand. The name must contain at least one letter or digit, and must not start with a space.

---

​

virtual_dataplane_id

virtual_dataplane_id: string

​

Description

The unique identifier of the virtual data plane the workspace is created in

---

​

workspace_creator?

optional workspace_creator?: string

Format: email

​

Description

Email of the user to grant the workspace-creator membership to (API key actors only). A signed-in user does not see the new workspace until their session refreshes, which happens on their next request to the control plane.