Environments
Environments.archive
POST
/v1/environments/{id}/archivex-api-key<token>
Workspace API key. Read from the x-api-key header by src/auth/api-key.ts. A key that is present and does not authenticate is final — no other scheme is consulted.
In: header
Path Parameters
id*string
Match
^(?:env)_[A-Za-z0-9_-]+$Header Parameters
idempotency-key?string
anthropic-beta?string
Accepted for Anthropic SDK compatibility and ignored. No value of this header changes request handling. Typed as a free-form string rather than an enum because this service recognises no specific beta value.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/environments/string/archive"{ "id": "string", "type": "environment", "name": "string", "description": "string", "metadata": { "property1": "string", "property2": "string" }, "config": { "type": "cloud", "networking": { "type": "unrestricted" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "string" ], "type": "packages" } }, "scope": "organization", "archived_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}