Update project
PATCH
/v1/projects/{projectId}How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| projectId | path | string | Yes | Project ID |
Query parameters
None.
Body schema
Content type: application/json · Optional
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | No | Human-readable name. |
| description | string | No | Human-readable description. |
| color | string | No | — |
| environmentIds | string[] | No | — |
| defaultEnvironmentId | string | No | — |
| cloneProjectDirectory | boolean | No | — |
| permissionSet | object | No | Agent permission policy. The shape is intentionally subject-typed so it can also be reused for human users and teams later. |
| permissionSet.version | 1 | No | — |
| permissionSet.subjectType | agent | human_user | team | project | security_repository | No | — |
| permissionSet.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| permissionSet.rings | object | No | — |
| permissionSet.actions | object | No | — |
| permissionSet.resources | object | No | — |
| permissionSet.resources.agents | object | No | — |
| permissionSet.resources.agents.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| permissionSet.resources.agents.rules | object[] | No | — |
| permissionSet.resources.agents.rules[].id | string | No | Optional stable rule ID. |
| permissionSet.resources.agents.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| permissionSet.resources.agents.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| permissionSet.resources.agents.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| permissionSet.resources.agents.rules[].note | string | No | Optional human-readable note for the rule. |
| permissionSet.resources.skills | object | No | — |
| permissionSet.resources.skills.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| permissionSet.resources.skills.rules | object[] | No | — |
| permissionSet.resources.skills.rules[].id | string | No | Optional stable rule ID. |
| permissionSet.resources.skills.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| permissionSet.resources.skills.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| permissionSet.resources.skills.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| permissionSet.resources.skills.rules[].note | string | No | Optional human-readable note for the rule. |
| permissionSet.resources.servers | object | No | — |
| permissionSet.resources.servers.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| permissionSet.resources.servers.rules | object[] | No | — |
| permissionSet.resources.servers.rules[].id | string | No | Optional stable rule ID. |
| permissionSet.resources.servers.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| permissionSet.resources.servers.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| permissionSet.resources.servers.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| permissionSet.resources.servers.rules[].note | string | No | Optional human-readable note for the rule. |
| permissionSet.resources.computers | object | No | — |
| permissionSet.resources.computers.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| permissionSet.resources.computers.rules | object[] | No | — |
| permissionSet.resources.computers.rules[].id | string | No | Optional stable rule ID. |
| permissionSet.resources.computers.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| permissionSet.resources.computers.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| permissionSet.resources.computers.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| permissionSet.resources.computers.rules[].note | string | No | Optional human-readable note for the rule. |
| permissionSet.resources.files | object | No | — |
| permissionSet.resources.files.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| permissionSet.resources.files.rules | object[] | No | — |
| permissionSet.resources.files.rules[].id | string | No | Optional stable rule ID. |
| permissionSet.resources.files.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| permissionSet.resources.files.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| permissionSet.resources.files.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| permissionSet.resources.files.rules[].note | string | No | Optional human-readable note for the rule. |
| permissionSet.resources.directories | object | No | — |
| permissionSet.resources.directories.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| permissionSet.resources.directories.rules | object[] | No | — |
| permissionSet.resources.directories.rules[].id | string | No | Optional stable rule ID. |
| permissionSet.resources.directories.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| permissionSet.resources.directories.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| permissionSet.resources.directories.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| permissionSet.resources.directories.rules[].note | string | No | Optional human-readable note for the rule. |
| permissionSet.resources.projects | object | No | — |
| permissionSet.resources.projects.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| permissionSet.resources.projects.rules | object[] | No | — |
| permissionSet.resources.projects.rules[].id | string | No | Optional stable rule ID. |
| permissionSet.resources.projects.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| permissionSet.resources.projects.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| permissionSet.resources.projects.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| permissionSet.resources.projects.rules[].note | string | No | Optional human-readable note for the rule. |
| permissionSet.resources.security_repositories | object | No | — |
| permissionSet.resources.security_repositories.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| permissionSet.resources.security_repositories.rules | object[] | No | — |
| permissionSet.resources.security_repositories.rules[].id | string | No | Optional stable rule ID. |
| permissionSet.resources.security_repositories.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| permissionSet.resources.security_repositories.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| permissionSet.resources.security_repositories.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| permissionSet.resources.security_repositories.rules[].note | string | No | Optional human-readable note for the rule. |
| metadata | object | No | Free-form metadata object. |
| missionControl | object | No | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Project updatedapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| project | object | Yes | — |
| project.object | project | project.overview | No | — |
| project.isOverviewRecord | boolean | No | — |
| project.id | string | Yes | Unique identifier. |
| project.userId | string | Yes | User ID. |
| project.ownerUserId | string | No | — |
| project.ownerName | string | No | — |
| project.ownerEmail | string | No | — |
| project.ownerAvatarUrl | string | No | — |
| project.owner | object | No | — |
| project.owner.userId | string | Yes | User ID. |
| project.owner.name | string | Yes | Human-readable name. |
| project.owner.email | string | No | — |
| project.owner.avatarUrl | string | No | — |
| project.canTransferOwnership | boolean | No | — |
| project.organizationId | string | No | — |
| project.createdByUserId | string | No | — |
| project.createdByName | string | No | — |
| project.createdByEmail | string | No | — |
| project.createdByAvatarUrl | string | No | — |
| project.createdBy | object | No | — |
| project.createdBy.userId | string | Yes | User ID. |
| project.createdBy.name | string | Yes | Human-readable name. |
| project.createdBy.email | string | No | — |
| project.createdBy.avatarUrl | string | No | — |
| project.name | string | Yes | Human-readable name. |
| project.description | string | Yes | Human-readable description. |
| project.type | local | cloud | synced | No | — |
| project.primarySource | string | No | — |
| project.sources | object[] | No | — |
| project.color | string | Yes | — |
| project.defaultEnvironmentId | string | Yes | — |
| project.environmentIds | string[] | No | — |
| project.permissionSet | object | No | Agent permission policy. The shape is intentionally subject-typed so it can also be reused for human users and teams later. |
| project.permissionSet.version | 1 | No | — |
| project.permissionSet.subjectType | agent | human_user | team | project | security_repository | No | — |
| project.permissionSet.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| project.permissionSet.rings | object | No | — |
| project.permissionSet.actions | object | No | — |
| project.permissionSet.resources | object | No | — |
| project.permissionSet.resources.agents | object | No | — |
| project.permissionSet.resources.agents.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| project.permissionSet.resources.agents.rules | object[] | No | — |
| project.permissionSet.resources.agents.rules[].id | string | No | Optional stable rule ID. |
| project.permissionSet.resources.agents.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| project.permissionSet.resources.agents.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| project.permissionSet.resources.agents.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| project.permissionSet.resources.agents.rules[].note | string | No | Optional human-readable note for the rule. |
| project.permissionSet.resources.skills | object | No | — |
| project.permissionSet.resources.skills.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| project.permissionSet.resources.skills.rules | object[] | No | — |
| project.permissionSet.resources.skills.rules[].id | string | No | Optional stable rule ID. |
| project.permissionSet.resources.skills.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| project.permissionSet.resources.skills.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| project.permissionSet.resources.skills.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| project.permissionSet.resources.skills.rules[].note | string | No | Optional human-readable note for the rule. |
| project.permissionSet.resources.servers | object | No | — |
| project.permissionSet.resources.servers.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| project.permissionSet.resources.servers.rules | object[] | No | — |
| project.permissionSet.resources.servers.rules[].id | string | No | Optional stable rule ID. |
| project.permissionSet.resources.servers.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| project.permissionSet.resources.servers.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| project.permissionSet.resources.servers.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| project.permissionSet.resources.servers.rules[].note | string | No | Optional human-readable note for the rule. |
| project.permissionSet.resources.computers | object | No | — |
| project.permissionSet.resources.computers.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| project.permissionSet.resources.computers.rules | object[] | No | — |
| project.permissionSet.resources.computers.rules[].id | string | No | Optional stable rule ID. |
| project.permissionSet.resources.computers.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| project.permissionSet.resources.computers.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| project.permissionSet.resources.computers.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| project.permissionSet.resources.computers.rules[].note | string | No | Optional human-readable note for the rule. |
| project.permissionSet.resources.files | object | No | — |
| project.permissionSet.resources.files.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| project.permissionSet.resources.files.rules | object[] | No | — |
| project.permissionSet.resources.files.rules[].id | string | No | Optional stable rule ID. |
| project.permissionSet.resources.files.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| project.permissionSet.resources.files.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| project.permissionSet.resources.files.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| project.permissionSet.resources.files.rules[].note | string | No | Optional human-readable note for the rule. |
| project.permissionSet.resources.directories | object | No | — |
| project.permissionSet.resources.directories.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| project.permissionSet.resources.directories.rules | object[] | No | — |
| project.permissionSet.resources.directories.rules[].id | string | No | Optional stable rule ID. |
| project.permissionSet.resources.directories.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| project.permissionSet.resources.directories.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| project.permissionSet.resources.directories.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| project.permissionSet.resources.directories.rules[].note | string | No | Optional human-readable note for the rule. |
| project.permissionSet.resources.projects | object | No | — |
| project.permissionSet.resources.projects.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| project.permissionSet.resources.projects.rules | object[] | No | — |
| project.permissionSet.resources.projects.rules[].id | string | No | Optional stable rule ID. |
| project.permissionSet.resources.projects.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| project.permissionSet.resources.projects.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| project.permissionSet.resources.projects.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| project.permissionSet.resources.projects.rules[].note | string | No | Optional human-readable note for the rule. |
| project.permissionSet.resources.security_repositories | object | No | — |
| project.permissionSet.resources.security_repositories.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| project.permissionSet.resources.security_repositories.rules | object[] | No | — |
| project.permissionSet.resources.security_repositories.rules[].id | string | No | Optional stable rule ID. |
| project.permissionSet.resources.security_repositories.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| project.permissionSet.resources.security_repositories.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| project.permissionSet.resources.security_repositories.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| project.permissionSet.resources.security_repositories.rules[].note | string | No | Optional human-readable note for the rule. |
| project.metadata | object | Yes | Free-form metadata object. |
| project.sharedWithMe | boolean | No | — |
| project.isShared | boolean | No | — |
| project.teamShared | boolean | No | — |
| project.teamShareId | string | No | — |
| project.teamId | string | No | — |
| project.teamName | string | No | — |
| project.teamAccessLevel | use | edit | manage | No | — |
| project.teamShareSource | resource_share | project_settings | No | — |
| project.summary | object | No | — |
| project.createdAt | string | Yes | ISO 8601 timestamp. |
| project.updatedAt | string | Yes | ISO 8601 timestamp. |
| summary | object | Yes | — |