Update Environment

Call Create environment first and replace env_123 with its returned ID.

POST /agent/v1/environments/{environment_id}◐ Partial

Request parameters

environment_idstring必填
path: Environment id, as returned by environments.create or environments.list. Built-in environments can be read but not changed.
namestring可选
Updated name for the environment
metadataobject可选
User-provided metadata key-value pairs. Set a value to null or empty string to delete the key.
configobject可选
Updated environment configuration
▸ 展开子字段（3）
- typestring必填
  Self-hosted environment selector; unsupported here and rejected with 400. Use a cloud environment instead.
  取值 self_hosted
- networkingobject可选
  Network configuration policy. Omit on update to preserve the existing value.
- packagesobject可选
  Specify packages (and optionally their versions) available in this environment. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. Under `limited` networking, requires `networking.allow_package_managers` to be `true`.
descriptionstring可选
Updated description of the environment. Omit to preserve; null clears to null; an empty string is stored as an empty string.
scopestring可选
The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only.

Returns

200

Supports tenant-owned cloud environments, configuration updates and soft archival; built-ins are read-only. Lists accept limit, page and include_archived. Limited networking applies at sandbox creation; package installation failure terminates the session with ENVIRONMENT_PACKAGE_INSTALL_FAILED. self_hosted, scope and cross-session package caching are not supported.

Errors follow the Anthropic error format (type / message / request_id) — see error codes

Response

HTTP 200

Successful response

application/json

Name	Type	Description
id	string	Environment identifier (e.g., 'env_...')
archived_at	null \| string	RFC 3339 timestamp when environment was archived, or null if not archived
config	object	Environment configuration (either Anthropic Cloud or self-hosted)
config.networking	object	Network configuration policy.
config.packages	object	Package manager configuration.
config.type	string	Environment type
created_at	string	RFC 3339 timestamp when environment was created
description	null \| string	User-provided description for the environment; null when unset
metadata	object	User-provided metadata key-value pairs
name	string	Human-readable name for the environment
type	string	The type of object (always 'environment')
updated_at	string	RFC 3339 timestamp when environment was last updated
scope	string	The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account.