Skip to main content
Vaults

删除 Vault

删除未被 Template 引用的 Vault。

路径

DELETE /api/v1/forward/vaults/{id}

请求头

头部必选说明
AuthorizationBearer <PAT 或 SAT>
删除前会执行 Template 引用检查。无引用时删除 Vault;删除后不再出现在默认列表中。

路径参数

参数类型必选说明
idstringVault ID。

查询参数

参数类型必选说明
identity_idstring仅在操作 Identity 归属资源时使用,非必填;PAT 场景可显式传入,未传时为管理员视角;SAT 场景请签发 Identity 维度凭证且不要显式携带该参数,否则返回 HTTP 400(详见 Identity 归属)。

示例请求

curl -X DELETE "https://api.qoder.com.cn/api/v1/forward/vaults/vault_xxx" \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

示例响应

{
  "id": "vault_xxx",
  "type": "vault_deleted",
  "deleted": true
}

响应字段解释

字段类型说明
idstring被删除资源的 ID。
typestring删除结果类型。
deletedboolean是否已删除。

错误码

HTTPtype触发条件
400invalid_request_error请求体、路径参数或分页参数非法;或 SAT 携带了 identity_id
401authentication_error缺少或无效的认证令牌。
403permission_error未指定 identity_id 的 PAT、Admin SAT 发生 Owner mismatch,或当前调用方存在其他权限不足。
404not_found_errorVault 不存在、未注册或不可见;或 identity_id 无效、已禁用、不属于当前调用方;或该资源不属于当前 Identity 归属。
409conflict_error幂等键冲突、创建恢复需要人工介入,或删除时仍被引用。
501feature_not_available当前尚未开放的 Vault 字段更新能力。
500/502/503api_errorForward 或依赖服务失败。