Update an execution workspace

PATCH/api/execution-workspaces/{id}
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Update an execution workspace.

Authorization

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. How keys work.

Path parameters

idstringRequiredThe execution workspace's id.

Request body

application/json · required

namestringOptionalat least 1 character
cwdstring | nullOptional
repoUrlstring | nullOptional
baseRefstring | nullOptional
branchNamestring | nullOptional
providerRefstring | nullOptional
statusstringOptionalone of: "active", "idle", "in_review", "archived", "cleanup_failed"
cleanupEligibleAtstring (date-time) | nullOptional
cleanupReasonstring | nullOptional
configobject | nullOptional
config.environmentIdstring (uuid) | nullOptional
config.provisionCommandstring | nullOptional
config.runtimeProvisionCommandstring | nullOptional
config.teardownCommandstring | nullOptional
config.cleanupCommandstring | nullOptional
config.workspaceRuntimeobject | nullOptional
config.desiredStatestring | nullOptionalone of: "running", "stopped", "manual"
config.serviceStatesobject<string, string> | nullOptional
metadataobject | nullOptional

Responses

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.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Workspaces