Archive Environment

Archive an execution environment; archived ones can no longer be used to create new sessions.

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

POST /agent/v1/environments/{environment_id}/archive◐ 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.

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.