Create a workspace.

Creates a workspace.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the organization.

Body Params

Workspace represents a sandbox workspace.

string

The description of the workspace.

options
object

Workspace creation options. Only used during upsert; never returned.

string

The client type that created the workspace, e.g. "harness".

spec
object

Create-time parameters of the workspace. On input (create/upsert),
carries requested parameters. On output, only spec.resources is
populated, with the resolved (provisioned) values; dependencies and
egress policy are never returned.

string

The name of the workspace template to base the workspace on: resolved
at creation time to whatever template currently carries that name
(convenience reference; set template_id instead to pin an exact
template). Applied only when creating a new workspace: the template is
resolved to a snapshot of its values at creation time, so later
template edits affect only newly created workspaces. On create,
conflicts with spec: set either template fields or explicit parameters,
never both. When upserting an existing workspace, spec may accompany an
echo-equal template reference: a read-modify-write round trip carries
both, and divergent values are rejected. Set at most
one of template_name/template_id on input; when both are set they must
refer to the same template. Immutable after creation: when upserting
an existing workspace, must be absent or equal to the stored value.
After creation, always populated together with template_id as a
historical record; template edits or deletion do not affect the
workspace.

string

The ID of the workspace template to base the workspace on, pinning an
exact template incarnation (strict reference; set template_name
instead to resolve whatever currently carries that name). Applied only
when creating a new workspace, with the same conflict, both-set
agreement and immutability rules as template_name. After creation,
always populated together with template_name as a historical record;
template edits or deletion do not affect the workspace.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json