COcoder
Workspaces

Get workspace metadata by user and workspace name

Changed on
get/api/v2/users/{user}/workspace/{workspacename}

Request

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

Path parameters

userstring required

User ID, name, or me

workspacenamestring required

Workspace name

Query parameters

include_deletedboolean

Return data instead of HTTP 404 if the workspace is deleted

include_relatedstring

Comma-separated list of related data to include (e.g. template,latest_build.resources.agents.*). Omit to include everything.

Response

OK

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