La referencia de la API se publica en inglés.

Create a project workspace

POST/api/projects/{id}/workspaces
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Create a project workspace.

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

idstringObligatorioThe project's id.

Cuerpo de la solicitud

application/json · obligatorio

namestringOpcionalat least 1 character
sourceTypestringOpcionalone of: "local_path", "git_repo", "remote_managed", "non_git_path"
cwdstring | nullOpcionalat least 1 character
repoUrlstring (uri) | nullOpcional
repoRefstring | nullOpcional
defaultRefstring | nullOpcional
visibilitystringOpcionalone of: "default", "advanced"
setupCommandstring | nullOpcional
cleanupCommandstring | nullOpcional
remoteProviderstring | nullOpcional
remoteWorkspaceRefstring | nullOpcional
sharedWorkspaceKeystring | nullOpcional
metadataobject | nullOpcional
runtimeConfigobject | nullOpcional
runtimeConfig.workspaceRuntimeobject | nullOpcional
runtimeConfig.desiredStatestring | nullOpcionalone of: "running", "stopped", "manual"
runtimeConfig.serviceStatesobject<string, string> | nullOpcional
isPrimarybooleanOpcional

Respuestas

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.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Projects