La référence de l'API est publiée en anglais.

Update a project workspace

PATCH/api/projects/{id}/workspaces/{workspaceId}
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Update a project workspace.

Autorisation

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. Fonctionnement des clés.

Paramètres de chemin

idstringObligatoireThe project's id.
workspaceIdstringObligatoireThe workspace's id.

Corps de la requête

application/json · obligatoire

namestringFacultatifat least 1 character
sourceTypestringFacultatifone of: "local_path", "git_repo", "remote_managed", "non_git_path"
cwdstring | nullFacultatifat least 1 character
repoUrlstring (uri) | nullFacultatif
repoRefstring | nullFacultatif
defaultRefstring | nullFacultatif
visibilitystringFacultatifone of: "default", "advanced"
setupCommandstring | nullFacultatif
cleanupCommandstring | nullFacultatif
remoteProviderstring | nullFacultatif
remoteWorkspaceRefstring | nullFacultatif
sharedWorkspaceKeystring | nullFacultatif
metadataobject | nullFacultatif
runtimeConfigobject | nullFacultatif
runtimeConfig.workspaceRuntimeobject | nullFacultatif
runtimeConfig.desiredStatestring | nullFacultatifone of: "running", "stopped", "manual"
runtimeConfig.serviceStatesobject<string, string> | nullFacultatif
isPrimarybooleanFacultatif

Réponses

200SuccessThe request worked; the body holds the result.
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.

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Projects