跳转到主要内容
POST /api/v1/cloud/environments/{environment_id} 更新指定环境的属性（如名称、描述、配置等）。

​
请求头

头部必选说明
Authorization是Bearer <PAT>
Content-Type是application/json

​
路径参数

参数类型必选说明
environment_idstring是环境的唯一标识（前缀为 env_）

​
请求体

仅需传入要更新的字段，未传入的字段保持不变。
字段类型必选说明
namestring否环境名称
descriptionstring否环境描述
configEnvironment config否替换已保存的 Environment 配置
metadataobject否Metadata 补丁。字符串值用于新增或更新 key；null 值用于删除已保存 metadata 中的 key

​
示例请求

curl -s -X POST "https://api.qoder.com/api/v1/cloud/environments/env_019e3bb39b6774d8878cd0b9d237574b" \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "用于 API 文档测试的环境"
  }'

​
示例响应

HTTP 200 OK 
{
  "id": "env_019e3bb39b6774d8878cd0b9d237574b",
  "type": "environment",
  "name": "doc-test-env",
  "description": "用于 API 文档测试的环境",
  "config": {
    "type": "cloud",
    "networking": {
      "type": "limited",
      "allowed_hosts": [],
      "allow_package_managers": false,
      "allow_mcp_servers": false
    },
    "packages": {
      "type": "packages",
      "apt": ["curl"],
      "npm": [],
      "pip": []
    }
  },
  "metadata": {},
  "archived_at": null,
  "created_at": "2026-05-18T15:28:07.017808Z",
  "updated_at": "2026-05-18T15:28:08.093156Z"
}

​
响应字段

字段类型说明
idstring环境唯一标识
typestring资源类型，固定值 "environment"
namestring环境名称
descriptionstring更新后的描述
configEnvironment configEnvironment 配置
metadataMetadata 对象自定义元数据
archived_atstring|null归档时间（ISO 8601），未归档时为 null
created_atstring创建时间（ISO 8601 格式）
updated_atstring最后更新时间（已更新为最新时间）

​
错误码

HTTPtype说明
400invalid_request_error请求体、config 或 metadata 字段值不合法
401authentication_error认证失败，PAT 无效或过期
403permission_error无权访问此资源
404not_found_error指定 ID 的环境不存在

​
注意事项

  • 未传入的字段保持不变
  • 显式传入 config 时，会用请求中的配置整体替换已保存的配置
  • 显式传入 metadata 时，字符串值会合并到已保存 metadata 对象中，null 值会删除已存在的 key

​
相关

云端环境

选择 Agent 运行的容器、网络与依赖。