Справочник API публикуется на английском языке.

Create a project workspace

POST/api/projects/{id}/workspaces
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Create a project workspace.

Авторизация

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. Как работают ключи.

Параметры пути

idstringОбязательныйThe project's id.

Тело запроса

application/json · обязательно

namestringНеобязательныйat least 1 character
sourceTypestringНеобязательныйone of: "local_path", "git_repo", "remote_managed", "non_git_path"
cwdstring | nullНеобязательныйat least 1 character
repoUrlstring (uri) | nullНеобязательный
repoRefstring | nullНеобязательный
defaultRefstring | nullНеобязательный
visibilitystringНеобязательныйone of: "default", "advanced"
setupCommandstring | nullНеобязательный
cleanupCommandstring | nullНеобязательный
remoteProviderstring | nullНеобязательный
remoteWorkspaceRefstring | nullНеобязательный
sharedWorkspaceKeystring | nullНеобязательный
metadataobject | nullНеобязательный
runtimeConfigobject | nullНеобязательный
runtimeConfig.workspaceRuntimeobject | nullНеобязательный
runtimeConfig.desiredStatestring | nullНеобязательныйone of: "running", "stopped", "manual"
runtimeConfig.serviceStatesobject<string, string> | nullНеобязательный
isPrimarybooleanНеобязательный

Ответы

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.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Projects