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

Update an execution workspace

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

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

Cuerpo de la solicitud

application/json · obligatorio

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

Respuestas

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.

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

Workspaces