--- title: "Archive Environment" method: POST path: "/v1/environments/{environment_id}/archive?beta=true" --- # Archive Environment `POST /v1/environments/{environment_id}/archive?beta=true` ## Request - Base URL: `https://api.anthropic.com` - URL: `https://api.anthropic.com/v1/environments/{environment_id}/archive?beta=true` - Auth: none declared Archive an environment by ID. Archived environments cannot be used to create new sessions. ## Path parameters - `environment_id` string, required ## Headers - `anthropic-beta` AnthropicBeta[]: Optional header to specify the beta version(s) you want to use. - union: Beta names you can send in the `anthropic-beta` header. See [Beta headers](https://platform.claude.com/docs/en/api/beta-headers) for how to send them and where to find the name a feature needs. - string - 'message-batches-2024-09-24' | 'prompt-caching-2024-07-31' | 'computer-use-2024-10-22' | 'computer-use-2025-01-24' | 'pdfs-2024-09-25' | 'token-counting-2024-11-01' | 'token-efficient-tools-2025-02-19' | 'output-128k-2025-02-19' | 'files-api-2025-04-14' | 'mcp-client-2025-04-04' | 'mcp-client-2025-11-20' | 'dev-full-thinking-2025-05-14' | 'interleaved-thinking-2025-05-14' | 'code-execution-2025-05-22' | 'extended-cache-ttl-2025-04-11' | 'context-1m-2025-08-07' | 'context-management-2025-06-27' | 'model-context-window-exceeded-2025-08-26' | 'skills-2025-10-02' | 'fast-mode-2026-02-01' | 'output-300k-2026-03-24' | 'user-profiles-2026-03-24' | 'user-profiles-2026-08-18' | 'user-profiles-2026-09-04' | 'advisor-tool-2026-03-01' | 'managed-agents-2026-04-01' | 'cache-diagnosis-2026-04-07' | 'dreaming-2026-04-21' | 'thinking-token-count-2026-05-13' | 'server-side-fallback-2026-06-01' | 'server-side-fallback-2026-07-01' | 'fallback-credit-2026-06-01' | 'fallback-credit-2026-07-01' | 'agent-memory-2026-07-22' | 'mid-conversation-tool-changes-2026-07-01' | 'compact-2026-01-12' | 'computer-use-2025-11-24' | 'mcp-tunnels-2026-06-22' | 'structured-outputs-2025-11-13' | 'task-budgets-2026-03-13' | 'thinking-display-updates-2026-08-18' | 'ce-user-management-2026-07-13' | 'mid-conversation-output-config-2026-07-01' | 'thinking-binding-controls-2026-08-01' | 'mid-conversation-system-clear-at-2026-08-21' | 'compact-2026-09-04' | 'inline-tools-2026-09-15' | 'mcp-client-2026-09-15' | 'ce-plugins-2026-09-01' | 'spend-limit-reads-2026-09-26' | 'telemetry-destinations-2026-08-11' | 'webhooks-2026-10-07' | 'admin-user-sign-out-2026-10-08' | 'message-threads-2026-08-12' | 'analytics-usage-cost-2026-08-24' | 'experimental-claude-tag-2026-10-21' - `anthropic-version` string: The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). - `anthropic-workspace-id` string ## Response `200` Successful Response - BetaEnvironment: Unified Environment resource for both cloud and self-hosted environments. - `archived_at` string, nullable, required: RFC 3339 timestamp when environment was archived, or null if not archived - `config` union, required: Environment configuration (either Anthropic Cloud or self-hosted) - BetaCloudConfig: `cloud` environment configuration. - `networking` union, required: Network configuration policy. - BetaUnrestrictedNetwork: Unrestricted network access. - `type` 'unrestricted', required: Network policy type - BetaLimitedNetwork: Limited network access. - `allow_mcp_servers` boolean, required: Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `allow_package_managers` boolean, required: Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `allowed_hosts` string[], required: Specifies domains the container can reach. - `type` 'limited', required: Network policy type - `packages` BetaPackages, required: Packages (and their versions) available in this environment. - `apt` string[], required: Ubuntu/Debian packages to install - `cargo` string[], required: Rust packages to install - `gem` string[], required: Ruby packages to install - `go` string[], required: Go packages to install - `npm` string[], required: Node.js packages to install - `pip` string[], required: Python packages to install - `type` 'packages': Package configuration type - `type` 'cloud', required: Environment type - BetaSelfHostedConfig: Configuration for self-hosted environments. - `type` 'self_hosted', required: Environment type - `created_at` string, required: RFC 3339 timestamp when environment was created - `description` string, nullable, required: User-provided description for the environment; null when unset - `id` string, required: Environment identifier (e.g., 'env_...') - `metadata` object, required: User-provided metadata key-value pairs - `name` string, required: Human-readable name for the environment - `scope` 'organization' | 'account': The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `type` 'environment', required: The type of object (always 'environment') - `updated_at` string, required: RFC 3339 timestamp when environment was last updated ## Other responses - `400`: Invalid argument - The client specified an invalid argument - `401`: Unauthenticated - The request does not have valid authentication credentials - `403`: Permission denied - The caller does not have permission to execute the specified operation - `404`: Not found - Some requested entity was not found - `408`: Deadline exceeded - The deadline expired before the operation could complete - `409`: Aborted - The operation was aborted due to concurrency issue - `412`: Failed precondition - Operation was rejected because the system is not in required state - `413`: Out of range - Operation was attempted past the valid range - `429`: Resource exhausted - Some resource has been exhausted (rate limiting) - `431`: Request header fields too large - Request metadata was too large - `499`: Cancelled - The operation was cancelled by the client - `500`: Internal - Internal server error - `501`: Unimplemented - The operation is not implemented or supported - `503`: Unavailable - The service is currently unavailable - `504`: Deadline exceeded - Upstream service did not respond in time - `529`: Overloaded - The service is temporarily overloaded ## Changes - **2026-11-05** `037a593978dc`: 1 info - added the enum value `admin-user-sign-out-2026-10-08` to the property `items/anyOf[subschema #2]/` of the `header` request parameter `anthropic-beta` - **2026-10-23** `f538a797852c`: 1 info - added the enum value `experimental-claude-tag-2026-10-21` to the property `items/anyOf[subschema #2]/` of the `header` request parameter `anthropic-beta` - **2026-10-23** `8071e43a8476`: 1 info - added the enum value `analytics-usage-cost-2026-08-24` to the property `items/anyOf[subschema #2]/` of the `header` request parameter `anthropic-beta` - **2026-10-22** `376dea998624`: 1 info - added the enum value `message-threads-2026-08-12` to the property `items/anyOf[subschema #2]/` of the `header` request parameter `anthropic-beta` - **2026-10-21** `b6f3fef9c0b5`: 1 info - added the enum value `webhooks-2026-10-07` to the property `items/anyOf[subschema #2]/` of the `header` request parameter `anthropic-beta` [Operation history](https://skmtc.dev/anthropics/apis/anthropic-api/changes/v1/environments/:environment_id/archive%3Fbeta=true/post.md) --- [API](https://skmtc.dev/anthropics/apis/anthropic-api.md) - [All operations](https://skmtc.dev/anthropics/apis/anthropic-api/llms.txt) - [OpenAPI document](https://skmtc.dev/anthropics/apis/anthropic-api/revisions/690622377a5e?raw)