Documentation Index
Fetch the complete documentation index at: https://docs.qoder.com/llms.txt
Use this file to discover all available pages before exploring further.
POST /v1/environments/{environment_id}/archive
Archives the specified environment. Once archived, the environment’s status becomes "archived" and it cannot host new sessions; existing sessions are unaffected.
| Header | Required | Description |
|---|
Authorization | Yes | Bearer <PAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|
environment_id | string | Yes | Environment unique identifier (with the env_ prefix) |
Request body
No request body.
Example request
curl -s -X POST 'https://openapi.qoder.sh/api/v1/cloud/environments/env_019e3bb39b6774d8878cd0b9d237574b/archive' \
-H "Authorization: Bearer $QODER_PAT"
Example response
HTTP 200 OK
{
"id": "env_019e3bb39b6774d8878cd0b9d237574b",
"type": "environment",
"name": "doc-test-env",
"description": "Environment used for API documentation testing",
"status": "archived",
"config": {
"type": "cloud",
"networking": {
"type": "limited"
},
"packages": {
"apt": [
"curl"
]
}
},
"created_at": "2026-05-18T15:28:07.017808Z",
"updated_at": "2026-05-18T15:28:08.459536Z"
}
Response fields
| Field | Type | Description |
|---|
id | string | Environment unique identifier |
type | string | Always "environment" |
name | string | Environment name |
description | string | Environment description |
status | string | Environment status; "archived" after this call |
config | object | Environment configuration |
created_at | string | Creation time (ISO 8601) |
updated_at | string | Time of the archive operation (ISO 8601) |
Errors
| HTTP | Type | Trigger |
|---|
| 401 | authentication_error | PAT invalid or expired |
| 403 | permission_error | Not authorized for this resource |
| 404 | not_found_error | Environment with the given ID does not exist |
| 409 | conflict_error | Environment is already archived |
