创建或更新工作区密钥

PUT /api/v1/projects/{id}/workspaces/{workspace_id}/secrets/{name}
持有者身份验证

验证密钥名称并将更新或插入请求更新或插入（upsert）到作用域为工作区的 ECP。项目范围由路由 ID 路径参数承载，而组织则派生自该项目。接受会话 JWT 或项目范围的API密钥，因此 CI/CD 可以播种短期构建凭证，而无需交互式登录； API密钥的作用域必须限定为路径中指定的项目。调用者需要该项目的部署管理权限（代理引擎原生项目上的 PROJECT_OWNER、AGENT_DEVELOPER、ORG_ADMIN 或 SYSTEM_ADMIN）。

路径参数

  • id 字符串 必需

    项目 ID

  • Workspace_id 字符串 必需

    工作区ID

  • 名称 字符串 必需

    密钥名称（大写 env-var 样式）

application/json

body 必需

密钥值和可选描述

  • 描述 字符串
  • 值 字符串
  • value_unchanged 布尔

    ValueUnchanged 必须由仅编辑现有密钥描述的调用者显式设立；这就是允许 Value 为空的原因。没有它，空值始终会被拒绝 - 调用者发送“”错误地（例如模板错误或未设置环境变量）获取明确的 400，而不是默默地保留旧值。

响应

  • 406

    不支持或格式不正确的API版本、所选已发布合约中不可用的操作或不可接受的表示形式（包括不支持的媒体类型参数或排除的 SSE）。现有的身份验证、授权和速率限制失败优先。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      标准错误模式定义的可选验证详细信息； API协商错误不会发出此字段。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        验证失败的字段。

        隐藏字段属性 显示字段属性 对象

        字段及其验证失败。

        • 描述 字符串 必需

          人类可读的验证失败。

        • 字段 字符串 必需

          无效请求字段的名称或路径。

    • 详细信息 字符串 必需

      人类可读的错误详细信息。

    • 错误 整型 必需

      HTTP status code.

    • 错误代码 字符串 必需

      机器可读的错误代码。

    • 参数 array[string]

      与错误相关的请求参数名称；不应用时省略。

    • 原因 字符串 必需

      HTTP状态原因短语。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      标准错误模式定义的可选验证详细信息； API协商错误不会发出此字段。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        验证失败的字段。

        隐藏字段属性 显示字段属性 对象

        字段及其验证失败。

        • 描述 字符串 必需

          人类可读的验证失败。

        • 字段 字符串 必需

          无效请求字段的名称或路径。

    • 详细信息 字符串 必需

      人类可读的错误详细信息。

    • 错误 整型 必需

      HTTP status code.

    • 错误代码 字符串 必需

      机器可读的错误代码。

    • 参数 array[string]

      与错误相关的请求参数名称；不应用时省略。

    • 原因 字符串 必需

      HTTP状态原因短语。
  • 200

    正常
  • 400

    Bad Request

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
  • 403

    Forbidden

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
  • 404

    未找到

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
  • 413

    请求实体太大

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
  • 429

    请求过多

    隐藏标头属性 显示标头属性
    • 重试后 字符串

      重试前等待的秒数

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
  • 502

    错误网关

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
  • 503

    服务不可用

    隐藏标头属性 显示标头属性
    • 重试后 字符串

      重试前等待的秒数

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
PUT /api/v1/projects/{id}/workspaces/{workspace_id}/secrets/{name} 
curl \
 --request PUT 'https://agentengine.mongodb.com/api/v1/projects/{id}/workspaces/{workspace_id}/secrets/{name}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "description": "string",
  "value": "string",
  "value_unchanged": true
}'
请求示例 
{
  "description": "string",
  "value": "string",
  "value_unchanged": true
}
响应示例 (406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
响应示例 (406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
响应示例 (200) 
{}
响应示例 (200) 
{}
响应示例 (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (403) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (413) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (413) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (429) 
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (429) 
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (502) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (502) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (503) 
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (503) 
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}