Page history
Archive Environment
api/beta/environments/archive
History
api/beta/environments/archive Changed · +15 / -1 lines
from line 16
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 38 more` - `"message-batches-2024-09-24"`
from line 85
- `"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"` ## Returns
api/beta/environments/archive Changed · +18 / -31 lines
# Archive Environment ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Archive Environment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
from line 1
---- -title: Archive Environment -url: https://platform.claude.com/docs/en/api/beta/environments/archive ---- +# Archive Environment -## Archive Environment +**POST** `/v1/environments/{environment_id}/archive` -**post** `/v1/environments/{environment_id}/archive` - Archive an environment by ID. Archived environments cannot be used to create new sessions. -### Path Parameters +## Path parameters - `environment_id: string` -### Header Parameters +## Headers - `"anthropic-beta": optional array of AnthropicBeta`
from line 86
- `"mid-conversation-tool-changes-2026-07-01"` -### Returns +## Returns -- `BetaEnvironment object { id, archived_at, config, 7 more }` +- `BetaEnvironment object` Unified Environment resource for both cloud and self-hosted environments.
from line 104
Environment configuration (either Anthropic Cloud or self-hosted) - - `BetaCloudConfig object { networking, packages, type }` + - `BetaCloudConfig object` `cloud` environment configuration.
from line 112
Network configuration policy. - - `BetaUnrestrictedNetwork object { type }` + - `BetaUnrestrictedNetwork object` Unrestricted network access.
from line 120
Network policy type - - `"unrestricted"` + - `BetaLimitedNetwork object` - - `BetaLimitedNetwork object { allow_mcp_servers, allow_package_managers, allowed_hosts, type }` - Limited network access. - `allow_mcp_servers: boolean`
from line 140
Network policy type - - `"limited"` - - `packages: BetaPackages` Package manager configuration.
from line 172
Package configuration type - - `"packages"` + default: packages - `type: "cloud"` Environment type - - `"cloud"` + - `BetaSelfHostedConfig object` - - `BetaSelfHostedConfig object { type }` - Configuration for self-hosted environments. - `type: "self_hosted"`
from line 186
Environment type - - `"self_hosted"` - - `created_at: string` RFC 3339 timestamp when environment was created
from line 206
The type of object (always 'environment') - - `"environment"` + default: environment - `updated_at: string`
from line 220
- `"account"` -### Example +## Example -```http +```bash curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \
from line 230
-H "X-Api-Key: $ANTHROPIC_API_KEY" ``` -#### Response +### Response (200) ```json {
api/beta/environments/archive Changed · +6 / -4 lines
from line 21
- `string` - - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more` + - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 31 more` - `"message-batches-2024-09-24"`
from line 67
- `"user-profiles-2026-03-24"` + - `"user-profiles-2026-08-18"` + - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"`
from line 203
RFC 3339 timestamp when environment was created - - `description: string` + - `description: string or null` - User-provided description for the environment + User-provided description for the environment; null when unset - `metadata: map[string]`
api/beta/environments/archive First recorded · 291 lines, first recorded
## Archive Environment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Archive Environment
url: https://platform.claude.com/docs/en/api/beta/environments/archive
---
## Archive Environment
**post** `/v1/environments/{environment_id}/archive`
Archive an environment by ID. Archived environments cannot be used to create new sessions.
### Path Parameters
- `environment_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"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"`
- `"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"`
### Returns
- `BetaEnvironment object { id, archived_at, config, 7 more }`
Unified Environment resource for both cloud and self-hosted environments.
- `id: string`
Environment identifier (e.g., 'env_...')
- `archived_at: string or null`
RFC 3339 timestamp when environment was archived, or null if not archived
- `config: BetaCloudConfig or BetaSelfHostedConfig`
Environment configuration (either Anthropic Cloud or self-hosted)
- `BetaCloudConfig object { networking, packages, type }`
`cloud` environment configuration.
- `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork`
Network configuration policy.
- `BetaUnrestrictedNetwork object { type }`
Unrestricted network access.
- `type: "unrestricted"`
Network policy type
- `"unrestricted"`
- `BetaLimitedNetwork object { allow_mcp_servers, allow_package_managers, allowed_hosts, type }`
Limited network access.
- `allow_mcp_servers: boolean`
Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array.
- `allow_package_managers: boolean`
Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array.
- `allowed_hosts: array of string`
Specifies domains the container can reach.
- `type: "limited"`
Network policy type
- `"limited"`
- `packages: BetaPackages`
Package manager configuration.
- `apt: array of string`
Ubuntu/Debian packages to install
- `cargo: array of string`
Rust packages to install
- `gem: array of string`
Ruby packages to install
- `go: array of string`
Go packages to install
- `npm: array of string`
Node.js packages to install
- `pip: array of string`
Python packages to install
- `type: optional "packages"`
Package configuration type
- `"packages"`
- `type: "cloud"`
Environment type
- `"cloud"`
- `BetaSelfHostedConfig object { type }`
Configuration for self-hosted environments.
- `type: "self_hosted"`
Environment type
- `"self_hosted"`
- `created_at: string`
RFC 3339 timestamp when environment was created
- `description: string`
User-provided description for the environment
- `metadata: map[string]`
User-provided metadata key-value pairs
- `name: string`
Human-readable name for the environment
- `type: "environment"`
The type of object (always 'environment')
- `"environment"`
- `updated_at: string`
RFC 3339 timestamp when environment was last updated
- `scope: optional "organization" or "account"`
The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account.
- `"organization"`
- `"account"`
### Example
```http
curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: managed-agents-2026-04-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
"archived_at": null,
"config": {
"networking": {
"allow_mcp_servers": false,
"allow_package_managers": true,
"allowed_hosts": [
"api.example.com"
],
"type": "limited"
},
"packages": {
"apt": [
"string"
],
"cargo": [
"string"
],
"gem": [
"string"
],
"go": [
"string"
],
"npm": [
"string"
],
"pip": [
"pandas",
"numpy"
],
"type": "packages"
},
"type": "cloud"
},
"created_at": "2026-03-15T10:00:00Z",
"description": "Python environment with data-analysis packages.",
"metadata": {},
"name": "python-data-analysis",
"type": "environment",
"updated_at": "2026-03-15T10:00:00Z",
"scope": "organization"
}
```