COcoder
Workspaces

Create user workspace

Changed on

Create a new workspace using a template. The request must specify either the Template ID or the Template Version ID, not both. If the Template ID is specified, the active version of the template will be used.

post/api/v2/users/{user}/workspaces

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v2/users/{user}/workspaces
  • Auth
    API key in header Coder-Session-Token

Path parameters

userstring required

Username, UUID, or me

Request body

automatic_updates'always' | 'never'
autostart_schedulestring
namestring required
template_idstring uuid

TemplateID specifies which template should be used for creating the workspace.

template_version_idstring uuid

TemplateVersionID can be used to specify a specific version of a template for creating the workspace.

template_version_preset_idstring uuid
ttl_msinteger

Response

Created

allow_renamesboolean

AllowRenames is the effective rename permission for this workspace, derived from the template's allow_workspace_renames setting and the deprecated deployment-wide flag.

automatic_updates'always' | 'never'
autostart_schedulestring
created_atstring date-time
deleting_atstring date-time

DeletingAt indicates the time at which the workspace will be permanently deleted. A workspace is eligible for deletion if it is dormant (a non-nil dormant_at value) and a value has been specified for time_til_dormant_autodelete on its template.

dormant_atstring date-time

DormantAt being non-nil indicates a workspace that is dormant. A dormant workspace is no longer accessible must be activated. It is subject to deletion if it breaches the duration of the time_til_ field on its template.

favoriteboolean
idstring uuid
is_prebuildboolean

IsPrebuild indicates whether the workspace is a prebuilt workspace. Prebuilt workspaces are owned by the prebuilds system user and have specific behavior, such as being managed differently from regular workspaces. Once a prebuilt workspace is claimed by a user, it transitions to a regular workspace, and IsPrebuild returns false.

last_used_atstring date-time
namestring
next_start_atstring date-time
organization_idstring uuid
organization_namestring
outdatedboolean
owner_avatar_urlstring
owner_idstring uuid
owner_namestring

OwnerName is the username of the owner of the workspace.

template_active_version_idstring uuid
template_allow_user_cancel_workspace_jobsboolean
template_display_namestring
template_iconstring
template_idstring uuid
template_namestring
template_require_active_versionboolean
template_use_classic_parameter_flowboolean
ttl_msinteger
updated_atstring date-time

Changes