API referansı İngilizce yayımlanır.

Update an execution workspace

PATCH/api/execution-workspaces/{id}
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Update an execution workspace.

Yetkilendirme

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. Anahtarlar nasıl çalışır.

Yol parametreleri

idstringZorunluThe execution workspace's id.

İstek gövdesi

application/json · zorunlu

namestringİsteğe bağlıat least 1 character
cwdstring | nullİsteğe bağlı
repoUrlstring | nullİsteğe bağlı
baseRefstring | nullİsteğe bağlı
branchNamestring | nullİsteğe bağlı
providerRefstring | nullİsteğe bağlı
statusstringİsteğe bağlıone of: "active", "idle", "in_review", "archived", "cleanup_failed"
cleanupEligibleAtstring (date-time) | nullİsteğe bağlı
cleanupReasonstring | nullİsteğe bağlı
configobject | nullİsteğe bağlı
config.environmentIdstring (uuid) | nullİsteğe bağlı
config.provisionCommandstring | nullİsteğe bağlı
config.runtimeProvisionCommandstring | nullİsteğe bağlı
config.teardownCommandstring | nullİsteğe bağlı
config.cleanupCommandstring | nullİsteğe bağlı
config.workspaceRuntimeobject | nullİsteğe bağlı
config.desiredStatestring | nullİsteğe bağlıone of: "running", "stopped", "manual"
config.serviceStatesobject<string, string> | nullİsteğe bağlı
metadataobject | nullİsteğe bağlı

Yanıtlar

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.

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Workspaces