使用补丁语义更新 Vault 的名称或元数据。display_name 和 metadata 至少提供一个。
前提
已完成 Endpoint 与鉴权配置,详见API 总览与认证。
接口
POST /vaults/{vault_id}
路径参数
| 参数 | 必填 | 类型 | 说明 |
|---|---|---|---|
vault_id | 是 | string | Vault ID,格式 vlt_xxx |
请求体
display_name 和 metadata 至少提供一个。
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
display_name | 否 | string | 新的可读名称,1-255 字符 |
metadata | 否 | object | 补丁语义:键设为字符串则追加或覆盖,设为 null 则删除该键 |
请求示例
响应
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
id | string | Vault ID,格式 vlt_xxx |
type | string | 固定为 vault |
display_name | string | Vault 可读名称 |
metadata | object | 业务自定义键值对 |
archived_at | string | null | 归档时间,未归档时为 null |
created_at | string | 创建时间,ISO 8601 |
updated_at | string | 最近更新时间,ISO 8601 |
错误码
| 状态码 | 错误码 | 说明 |
|---|---|---|
| 400 | InvalidParameter | Required parameter missing or invalid. |
| 401 | InvalidApiKey | Invalid API-key provided. |