Sign in

v1

latestOpenAPI 3.0.32026-07-17136180270.3 KB
Workspaces

Create a workspace

Create a workspace. Accepts a JSON request body when defined and returns the resulting resource or action status.

post/api/projects/{projectId}/workspaces/

Path parameters

projectIdstring required

Project identifier used to scope the request.

Request body

pathstring required

File system path or repository-relative path.

sourceTypestring

Workspace source type. Defaults to local when omitted.

displayNamestring

Optional display name shown to users.

Response

Workspace

idstring required

Stable identifier for the object.

projectIdstring required

Project identifier that owns or scopes this object.

pathstring required

File system path or repository-relative path.

displayNamestring nullable

Optional display name shown to users.

sourceTypestring required

source Type value for the workspace object.

autoGeneratedboolean required

auto Generated value for the workspace object.

statusstring required

Current status value.

errorMessagestring nullable

Detailed error message, when present.

createdAtstring date-time required

Time when the object was created.

updatedAtstring date-time required

Time when the object was last updated.