Skip to main content
POST
Create a workspace

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

virtual_dataplane_id
string
required

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

Body

application/json

Request body for creating a workspace

name
string
required

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.

Maximum string length: 200
description
string

Workspace description

workspace_creator
string<email>

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.

Response

Workspace created successfully

The created workspace

success
boolean
required
data
object
required

Workspace object