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

Update project properties and defaults

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

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.

Авторизация

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

Тело запроса

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

goalIdstring (uuid) | nullНеобязательный
goalIdsarray<string (uuid)>Необязательный
namestringНеобязательныйat least 1 character
descriptionstring | nullНеобязательный
visibilitystringНеобязательныйone of: "open", "private"
statusstringНеобязательныйone of: "backlog", "planned", "in_progress", "completed", "cancelled"
leadAgentIdstring (uuid) | nullНеобязательный
decisionOwnerUserIdstring | nullНеобязательныйat least 1 character
targetDatestring | nullНеобязательный
colorstring | nullНеобязательный
iconstring | nullНеобязательный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Необязательный
executionWorkspacePolicyobject | nullНеобязательный
executionWorkspacePolicy.enabledbooleanОбязательный
executionWorkspacePolicy.sharedWorkspaceConcurrencystringНеобязательныйone of: "auto", "serialize", "allow"
executionWorkspacePolicy.defaultModestringНеобязательныйone of: "shared_workspace", "isolated_workspace", "operator_branch", "adapter_default"
executionWorkspacePolicy.allowIssueOverridebooleanНеобязательный
executionWorkspacePolicy.defaultProjectWorkspaceIdstring (uuid) | nullНеобязательный
executionWorkspacePolicy.environmentIdstring (uuid) | nullНеобязательный
executionWorkspacePolicy.storageProviderPluginIdstring (uuid) | nullНеобязательный
executionWorkspacePolicy.workspaceStrategyobject | nullНеобязательный
executionWorkspacePolicy.workspaceStrategy.typestringНеобязательныйone of: "project_primary", "git_worktree", "adapter_managed", "cloud_sandbox"
executionWorkspacePolicy.workspaceStrategy.baseRefstring | nullНеобязательный
executionWorkspacePolicy.workspaceStrategy.branchTemplatestring | nullНеобязательный
executionWorkspacePolicy.workspaceStrategy.worktreeParentDirstring | nullНеобязательный
executionWorkspacePolicy.workspaceStrategy.provisionCommandstring | nullНеобязательный
executionWorkspacePolicy.workspaceStrategy.runtimeProvisionCommandstring | nullНеобязательный
executionWorkspacePolicy.workspaceStrategy.teardownCommandstring | nullНеобязательный
executionWorkspacePolicy.workspaceRuntimeobject | nullНеобязательный
executionWorkspacePolicy.branchPolicyobject | nullНеобязательный
executionWorkspacePolicy.pullRequestPolicyobject | nullНеобязательный
executionWorkspacePolicy.runtimePolicyobject | nullНеобязательный
executionWorkspacePolicy.cleanupPolicyobject | nullНеобязательный
executionWorkspacePolicy.authorizationPolicyobject | nullНеобязательный
executionWorkspacePolicy.authorizationPolicy.trustPresetstringНеобязательныйone of: "standard", "low_trust_review"
executionWorkspacePolicy.authorizationPolicy.reviewPresetobjectНеобязательный
executionWorkspacePolicy.authorizationPolicy.trustBoundaryobjectНеобязательный
executionWorkspacePolicy.authorizationPolicy.assignmentPolicyobjectНеобязательный
executionWorkspacePolicy.authorizationPolicy.protectedAgentobjectНеобязательный
archivedAtstring (date-time) | 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. Подробнее: ошибки и ограничения.

Projects