Skip to main content
Vaults

创建 Vault

Forward Vaults API 接口说明。

描述

创建 Vault,并设置 metadata。

路径

POST /api/v1/forward/vaults

请求头

头部必选说明
AuthorizationBearer <PAT 或 SAT>
Idempotency-Key可选创建请求幂等键。传入时相同 key 只能用于相同请求;不传时不提供本地幂等重放保护。
Content-Typeapplication/json

请求体

字段类型必选说明
display_namestringVault 展示名。
metadataobject元数据对象;created_by 为保留字段,不可传入(传入返回 400)。

示例请求

curl -X POST "https://api.qoder.com/api/v1/forward/vaults" \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "mcp-vault",
    "metadata": {"source": "console"}
  }'

示例响应

HTTP 201 Created
{
  "id": "vault_xxx",
  "type": "vault",
  "display_name": "mcp-vault",
  "metadata": {
    "source": "console"
  },
  "created_at": "2026-07-23T10:00:00Z",
  "updated_at": "2026-07-23T10:00:00Z",
  "identity_id": null
}

响应字段解释

字段类型说明
idstringVault ID。
typestring固定为 vault
display_namestringVault 展示名。
metadataobjectVault 元数据。
created_atstring创建时间,RFC 3339 格式。
updated_atstring最后更新时间,RFC 3339 格式。
identity_idstring/nullForward 归属身份。

错误码

HTTPtype触发条件
400invalid_request_error请求体、路径参数或查询参数非法。
400invalid_request_error传入保留键 created_by 时,messagemetadata key "created_by" is reserved,可据此定位到具体字段。
401authentication_error缺少或无效的认证令牌。
403permission_error当前调用方无权访问该资源。
409conflict_error资源状态、引用关系或幂等键冲突。
500/502/503api_errorForward 或依赖服务失败。