Create a project workspace

POST/api/projects/{id}/workspaces
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Create a project workspace.

Authorization

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.

Path parameters

idstringRequiredThe project's id.

Request body

application/json · required

namestringOptionalat least 1 character
sourceTypestringOptionalone of: "local_path", "git_repo", "remote_managed", "non_git_path"
cwdstring | nullOptionalat least 1 character
repoUrlstring (uri) | nullOptional
repoRefstring | nullOptional
defaultRefstring | nullOptional
visibilitystringOptionalone of: "default", "advanced"
setupCommandstring | nullOptional
cleanupCommandstring | nullOptional
remoteProviderstring | nullOptional
remoteWorkspaceRefstring | nullOptional
sharedWorkspaceKeystring | nullOptional
metadataobject | nullOptional
runtimeConfigobject | nullOptional
runtimeConfig.workspaceRuntimeobject | nullOptional
runtimeConfig.desiredStatestring | nullOptionalone of: "running", "stopped", "manual"
runtimeConfig.serviceStatesobject<string, string> | nullOptional
isPrimarybooleanOptional

Responses

201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Projects