Skip to main content

Credential

密钥(Credential)API 提供保险箱内具体密钥的创建、查询、更新、归档与删除操作。

创建 Credential

POST /credentials

请求体

字段必填类型说明
vault_idstring所属密钥库 ID
namestring密钥显示名称
keystring变量名,供工具引用,例如 MY_API_KEY
valuestring变量值,实际密钥内容。保存后不再展示明文
metadataobject业务自定义键值

请求示例

curl -X POST "$AGENTSTUDIO_URL/credentials" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vault_id": "vault_xxx",
    "name": "GitHub Token",
    "key": "GITHUB_TOKEN",
    "value": "ghp_xxxxxxxxxxxx"
  }'

获取 Credential

GET /credentials/{credential_id} 返回密钥元数据(不含 value 明文)。

列出 Credential

GET /credentials 分页列出指定密钥库下的密钥。支持 vault_id 查询参数筛选。

更新 Credential

PATCH /credentials/{credential_id} 可更新 name、key、value。

删除 Credential

DELETE /credentials/{credential_id} 硬删除,不可恢复。

归档 Credential

POST /credentials/{credential_id}/archive 软归档。