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.
PUT /v1/environments/{environment_id}
Updates the properties of the specified environment (name, description, configuration, and so on).
| Header | Required | Description |
|---|
Authorization | Yes | Bearer <PAT> |
Content-Type | Yes | application/json |
Path parameters
| Parameter | Type | Required | Description |
|---|
environment_id | string | Yes | Environment unique identifier (with the env_ prefix) |
Request body
Only the fields included in the request are updated; omitted fields remain unchanged.
| Field | Type | Required | Description |
|---|
name | string | No | New environment name |
description | string | No | New environment description |
config | object | No | New environment configuration |
config.type | string | Yes (when config is sent) | Always "cloud" |
config.networking | object | No | Network access configuration |
config.networking.type | string | No | Network type: "unrestricted", "limited", or "allowlist" |
config.networking.allowed_hosts | array | No | Allowlist of hosts |
config.networking.allow_package_managers | boolean | No | Whether to allow package manager network access |
config.packages | object | No | Pre-installed package configuration |
config.packages.apt | array | No | List of apt packages |
config.packages.pip | array | No | List of pip packages |
config.packages.npm | array | No | List of npm packages |
metadata | object | No | Custom metadata key-value pairs |
Example request
curl -s -X PUT 'https://openapi.qoder.sh/api/v1/cloud/environments/env_019e3bb39b6774d8878cd0b9d237574b' \
-H "Authorization: Bearer $QODER_PAT" \
-H 'Content-Type: application/json' \
-d '{
"description": "Environment used for API documentation testing"
}'
Example response
HTTP 200 OK
{
"id": "env_019e3bb39b6774d8878cd0b9d237574b",
"type": "environment",
"name": "doc-test-env",
"description": "Environment used for API documentation testing",
"status": "ready",
"config": {
"type": "cloud",
"networking": {
"type": "limited"
},
"packages": {
"apt": [
"curl"
]
}
},
"created_at": "2026-05-18T15:28:07.017808Z",
"updated_at": "2026-05-18T15:28:08.093156Z"
}
Response fields
| Field | Type | Description |
|---|
id | string | Environment unique identifier |
type | string | Always "environment" |
name | string | Environment name |
description | string | Updated description |
status | string | Environment status |
config | object | Environment configuration |
created_at | string | Creation time (ISO 8601) |
updated_at | string | Last update time (refreshed) |
Errors
| HTTP | Type | Trigger |
|---|
| 400 | invalid_request_error | Invalid request parameters |
| 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 |
