Patch computer

PATCH/v1/environments/{environmentId}

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
NameLocationTypeRequiredDescription
environmentIdpathstringYesEnvironment ID
Query parameters
None.

Body schema

Content type: application/json · Optional

FieldTypeRequiredDescription
projectIdstringNoOptional project that owns this computer.
namestringNoHuman-readable name.
descriptionstringNoHuman-readable description.
environmentVariablesobject[]No—
environmentVariables[].keystringNo—
environmentVariables[].valuestringNo—
secretsobject[]No—
setupScriptsstring[]No—
mcpServersobject[]No—
mcpServers[].namestringNoHuman-readable name.
mcpServers[].typestdio | httpNo—
mcpServers[].commandstringNoFor stdio servers
mcpServers[].argsstring[]No—
mcpServers[].urlstringNoFor HTTP servers
mcpServers[].bearerTokenstringNo—
mcpServers[].enabledbooleanNo—
documentationstring[]No—
internetAccessbooleanNo—
isDefaultbooleanNo—
computeProfilelite | standard | power | desktopNoResize the computer by switching to a named ACP profile.
baseImagestringNo—
dockerfileExtensionsstringNo—
runtimesobjectNo—
packagesobjectNo—
packages.systemstring[]No—
packages.pythonstring[]No—
packages.nodestring[]No—
guiEnabledbooleanNoBackwards-compatible alias. True upgrades to Desktop; false downgrades Desktop back to the default non-GUI profile.
officeAppsEnabledbooleanNoBackwards-compatible alias. True upgrades to Desktop; false downgrades Desktop back to the default non-GUI profile.
metadataobjectNoFree-form metadata object.
metadata.computeProfilelite | standard | power | desktopNoNamed ACP computer profile controlling runtime resources and pricing.
metadata.computeResourcesobjectNo—
metadata.computeResources.cpuCoresnumberNo—
metadata.computeResources.memoryMbintegerNo—
metadata.pricingobjectNo—
metadata.pricing.minutePricenumberNoRuntime price in USD per minute for the selected computer profile.
metadata.guiEnabledbooleanNoWhether this computer profile exposes a GUI session.
metadata.officeAppsEnabledbooleanNoWhether desktop productivity apps are enabled for this computer profile.

What the API returns

Each response code below includes the documented payload shape for the ACP API.

200Environment updatedapplication/json
FieldTypeRequiredDescription
environmentobjectNo—
environment.idstringNoUnique identifier.
environment.userIdstringNoUser ID.
environment.organizationIdstringNo—
environment.createdByUserIdstringNo—
environment.projectIdstringNoProject ID.
environment.namestringNoHuman-readable name.
environment.descriptionstringNoHuman-readable description.
environment.environmentVariablesobject[]No—
environment.environmentVariables[].keystringNo—
environment.environmentVariables[].valuestringNo—
environment.secretsobject[]No—
environment.setupScriptsstring[]No—
environment.mcpServersobject[]No—
environment.mcpServers[].namestringNoHuman-readable name.
environment.mcpServers[].typestdio | httpNo—
environment.mcpServers[].commandstringNoFor stdio servers
environment.mcpServers[].argsstring[]No—
environment.mcpServers[].urlstringNoFor HTTP servers
environment.mcpServers[].bearerTokenstringNo—
environment.mcpServers[].enabledbooleanNo—
environment.internetAccessbooleanNo—
environment.isDefaultbooleanNo—
environment.baseImagestringNo—
environment.dockerfileExtensionsstringNo—
environment.runtimesobjectNo—
environment.packagesobjectNo—
environment.packages.systemstring[]No—
environment.packages.pythonstring[]No—
environment.packages.nodestring[]No—
environment.metadataobjectNoFree-form metadata object.
environment.metadata.computeProfilelite | standard | power | desktopNoNamed ACP computer profile controlling runtime resources and pricing.
environment.metadata.computeResourcesobjectNo—
environment.metadata.computeResources.cpuCoresnumberNo—
environment.metadata.computeResources.memoryMbintegerNo—
environment.metadata.pricingobjectNo—
environment.metadata.pricing.minutePricenumberNoRuntime price in USD per minute for the selected computer profile.
environment.metadata.guiEnabledbooleanNoWhether this computer profile exposes a GUI session.
environment.metadata.officeAppsEnabledbooleanNoWhether desktop productivity apps are enabled for this computer profile.
environment.buildStatusstringNo—
environment.buildErrorstringNo—
environment.imageTagstringNo—
environment.lastBuildAtstringNo—
environment.createdAtstringNoISO 8601 timestamp.
environment.updatedAtstringNoISO 8601 timestamp.
Patch computer
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow