API referansı İngilizce yayımlanır.

Update project properties and defaults

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

Update project properties and defaults.

Save project properties and defaults. The description holds shared project context and guidance, including checklists; goalIds links the project to its goals. Read the project back to verify the saved fields. Updating description or goalIds does not rewrite existing tasks or the inputs already admitted to active native runs; changing existing work is a separate operation. Environment and executionWorkspacePolicy fields configure separate project settings and are not required to save description or goalIds. Archiving a project (archivedAt set to the current time) hides it from the sidebar and project selectors and keeps the project, its tasks and their history; no data is removed. Restoring sets archivedAt to null. A person unarchives a project on that project's own Configuration page, //projects//configuration, with the Unarchive button; give them that page as a Markdown link. Archived projects are not restored from the organization Status page.

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 project's id.

İstek gövdesi

application/json · zorunlu

goalIdstring (uuid) | nullİsteğe bağlı
goalIdsarray<string (uuid)>İsteğe bağlı
namestringİsteğe bağlıat least 1 character
descriptionstring | nullİsteğe bağlı
visibilitystringİsteğe bağlıone of: "open", "private"
statusstringİsteğe bağlıone of: "backlog", "planned", "in_progress", "completed", "cancelled"
leadAgentIdstring (uuid) | nullİsteğe bağlı
decisionOwnerUserIdstring | nullİsteğe bağlıat least 1 character
targetDatestring | nullİsteğe bağlı
colorstring | nullİsteğe bağlı
iconstring | nullİsteğe bağlıone of: "folder", "rocket", "code", "terminal", "database", "globe", "package", "boxes", "box", "layers", "briefcase", "compass", "target", "flame", "zap", "star", "bug", "wrench", "hammer", "lightbulb", "sparkles", "shield", "lock", "search", "cog", "brain", "cpu", "git-branch", "file-code", "puzzle", "gem", "atom", "heart", "mail", "message-square", "crown", "radar", "telescope", "hexagon"
envobject<string, string | object> | nullİsteğe bağlı
executionWorkspacePolicyobject | nullİsteğe bağlı
executionWorkspacePolicy.enabledbooleanZorunlu
executionWorkspacePolicy.sharedWorkspaceConcurrencystringİsteğe bağlıone of: "auto", "serialize", "allow"
executionWorkspacePolicy.defaultModestringİsteğe bağlıone of: "shared_workspace", "isolated_workspace", "operator_branch", "adapter_default"
executionWorkspacePolicy.allowIssueOverridebooleanİsteğe bağlı
executionWorkspacePolicy.defaultProjectWorkspaceIdstring (uuid) | nullİsteğe bağlı
executionWorkspacePolicy.environmentIdstring (uuid) | nullİsteğe bağlı
executionWorkspacePolicy.storageProviderPluginIdstring (uuid) | nullİsteğe bağlı
executionWorkspacePolicy.workspaceStrategyobject | nullİsteğe bağlı
executionWorkspacePolicy.workspaceStrategy.typestringİsteğe bağlıone of: "project_primary", "git_worktree", "adapter_managed", "cloud_sandbox"
executionWorkspacePolicy.workspaceStrategy.baseRefstring | nullİsteğe bağlı
executionWorkspacePolicy.workspaceStrategy.branchTemplatestring | nullİsteğe bağlı
executionWorkspacePolicy.workspaceStrategy.worktreeParentDirstring | nullİsteğe bağlı
executionWorkspacePolicy.workspaceStrategy.provisionCommandstring | nullİsteğe bağlı
executionWorkspacePolicy.workspaceStrategy.runtimeProvisionCommandstring | nullİsteğe bağlı
executionWorkspacePolicy.workspaceStrategy.teardownCommandstring | nullİsteğe bağlı
executionWorkspacePolicy.workspaceRuntimeobject | nullİsteğe bağlı
executionWorkspacePolicy.branchPolicyobject | nullİsteğe bağlı
executionWorkspacePolicy.pullRequestPolicyobject | nullİsteğe bağlı
executionWorkspacePolicy.runtimePolicyobject | nullİsteğe bağlı
executionWorkspacePolicy.cleanupPolicyobject | nullİsteğe bağlı
executionWorkspacePolicy.authorizationPolicyobject | nullİsteğe bağlı
executionWorkspacePolicy.authorizationPolicy.trustPresetstringİsteğe bağlıone of: "standard", "low_trust_review"
executionWorkspacePolicy.authorizationPolicy.reviewPresetobjectİsteğe bağlı
executionWorkspacePolicy.authorizationPolicy.trustBoundaryobjectİsteğe bağlı
executionWorkspacePolicy.authorizationPolicy.assignmentPolicyobjectİsteğe bağlı
executionWorkspacePolicy.authorizationPolicy.protectedAgentobjectİsteğe bağlı
archivedAtstring (date-time) | 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.

Projects