Sign in

Update Environment

Update an existing environment's configuration.

post/v1/environments/{environment_id}?beta=true

Path parameters

environment_idstring required

Headers

anthropic-betastring

Optional header to specify the beta version(s) you want to use.

To use multiple betas, use a comma separated list like beta1,beta2 or specify the header multiple times for each beta.

Optional header to specify the beta version(s) you want to use.

To use multiple betas, use a comma separated list like beta1,beta2 or specify the header multiple times for each beta.

anthropic-versionstring

The version of the Claude API you want to use.

Read more about versioning and our version history here.

The version of the Claude API you want to use.

Read more about versioning and our version history here.

Request body

descriptionstring nullable

Updated description of the environment. Omit to preserve; null clears to null; an empty string is stored as an empty string.

metadataobject

User-provided metadata key-value pairs. Set a value to null or empty string to delete the key.

namestring nullable

Updated name for the environment

scope'organization' | 'account' nullable

The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only.

Example request

{
  "description": "Python environment with data-analysis packages."
}

Response

Successful Response

archived_atstring nullable required

RFC 3339 timestamp when environment was archived, or null if not archived

created_atstring required

RFC 3339 timestamp when environment was created

descriptionstring nullable required

User-provided description for the environment; null when unset

idstring required

Environment identifier (e.g., 'env_...')

metadataobject required

User-provided metadata key-value pairs

namestring 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_atstring required

RFC 3339 timestamp when environment was last updated

Example response

{
  "type": "environment",
  "id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
  "name": "python-data-analysis",
  "description": "Python environment with data-analysis packages.",
  "config": {
    "type": "cloud",
    "networking": {
      "type": "limited",
      "allowed_hosts": [
        "api.example.com"
      ],
      "allow_package_managers": true,
      "allow_mcp_servers": false
    },
    "packages": {
      "type": "packages",
      "pip": [
        "pandas",
        "numpy"
      ],
      "npm": [],
      "apt": [],
      "cargo": [],
      "gem": [],
      "go": []
    }
  },
  "metadata": {},
  "archived_at": null,
  "created_at": "2026-03-15T10:00:00Z",
  "updated_at": "2026-03-15T10:00:00Z"
}

Changes

Changed in 4 of the 68 revisions of this API.216

  • e9d8152420c31See the full diff
    • ▲

      response property description list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 40e330aba8bc15See the full diff
    • ▲

      added to the response property oneOf list for the response status

      response-property-one-of-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added self_hosted discriminator mapping keys to the / request property

      request-property-discriminator-mapping-added

    • ○

      added to the / request property oneOf list

      request-property-one-of-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added self_hosted discriminator mapping keys to the response property for the response status

      response-property-discriminator-mapping-added

  • d87d3ef6f6361See the full diff
    • ●

      deleted the cookie request parameter sessionKey

      request-parameter-removed

  • 69486316563e1See the full diff
    • ○

      endpoint added

      endpoint-added