workspaces

Get Workspace By Path

Get workspace by machine ID and local path.

get/api/v1/workspaces/by-path

Query parameters

machine_idstring required

local_pathstring required

Successful Response

idstring required

Unique workspace identifier

user_idstring required

Owner user identifier

git_hoststring nullable

Canonical git host (e.g., github.com)

git_pathstring nullable

Canonical git repository path (e.g., org/repo)

workspace_metadataobject nullable

Arbitrary workspace metadata (labels, annotations)

created_atstring date-time required

Timestamp when the workspace was created

updated_atstring date-time required

Timestamp when the workspace was last updated

No recorded changes to this endpoint across all 1 revision of this API.