API referansı İngilizce yayımlanır.
Create a project workspace
POST
/api/projects/{id}/workspacesPersonal API keyAgent API keyConsole session
Create a project workspace.
Yetkilendirme
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. Anahtarlar nasıl çalışır.
Yol parametreleri
idstringZorunluThe project's id.
İstek gövdesi
application/json · zorunlu
namestringİsteğe bağlı
at least 1 charactersourceTypestringİsteğe bağlı
one of: "local_path", "git_repo", "remote_managed", "non_git_path"cwdstring | nullİsteğe bağlı
at least 1 characterrepoUrlstring (uri) | nullİsteğe bağlı
repoRefstring | nullİsteğe bağlı
defaultRefstring | nullİsteğe bağlı
visibilitystringİsteğe bağlı
one of: "default", "advanced"setupCommandstring | nullİsteğe bağlı
cleanupCommandstring | nullİsteğe bağlı
remoteProviderstring | nullİsteğe bağlı
remoteWorkspaceRefstring | nullİsteğe bağlı
sharedWorkspaceKeystring | nullİsteğe bağlı
metadataobject | nullİsteğe bağlı
runtimeConfigobject | nullİsteğe bağlı
runtimeConfig.workspaceRuntimeobject | nullİsteğe bağlı
runtimeConfig.desiredStatestring | nullİsteğe bağlı
one of: "running", "stopped", "manual"runtimeConfig.serviceStatesobject<string, string> | nullİsteğe bağlı
isPrimarybooleanİsteğe bağlı
Yanıtlar
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.
Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.