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

Update an execution workspace

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

Update an execution 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 execution workspace's id.

Тело запроса

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

namestringНеобязательныйat least 1 character
cwdstring | nullНеобязательный
repoUrlstring | nullНеобязательный
baseRefstring | nullНеобязательный
branchNamestring | nullНеобязательный
providerRefstring | nullНеобязательный
statusstringНеобязательныйone of: "active", "idle", "in_review", "archived", "cleanup_failed"
cleanupEligibleAtstring (date-time) | nullНеобязательный
cleanupReasonstring | nullНеобязательный
configobject | nullНеобязательный
config.environmentIdstring (uuid) | nullНеобязательный
config.provisionCommandstring | nullНеобязательный
config.runtimeProvisionCommandstring | nullНеобязательный
config.teardownCommandstring | nullНеобязательный
config.cleanupCommandstring | nullНеобязательный
config.workspaceRuntimeobject | nullНеобязательный
config.desiredStatestring | nullНеобязательныйone of: "running", "stopped", "manual"
config.serviceStatesobject<string, string> | nullНеобязательный
metadataobject | nullНеобязательный

Ответы

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.

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

Workspaces