# 快速开始 (/docs/cloud/services/vault/quickstart)



把 API Key 放进 `PRAXIS_API_KEY` 环境变量，依次运行下面三个请求。每次运行都会创建一个新库。请先安装 `jq` 以提取 ID；可设置 `VAULT_NAME` 自选显示名称。

## 1. 建库 [#1-建库]

```bash
VAULT_JSON=$(curl --fail-with-body -sS -X POST "https://api.deepraxis.ai/vault/v1/vaults" \
  -H "Authorization: Bearer $PRAXIS_API_KEY" \
  -H "Content-Type: application/json" \
  -d "$(jq -n --arg name "${VAULT_NAME:-Agent credentials}" '{display_name: $name}')")
export VAULT_ID=$(printf '%s' "$VAULT_JSON" | jq -er '.id')
printf '%s\n' "$VAULT_JSON"
```

期望：HTTP 200，返回 `type` 为 `vault`、`status` 为 `active`、`secret_count` 为 `0` 的对象。命令已把返回的 `vlt_` ID 保存到 `VAULT_ID`。

## 2. 加入 Secret [#2-加入-secret]

```bash
curl -X POST "https://api.deepraxis.ai/vault/v1/vaults/$VAULT_ID/secrets" \
  -H "Authorization: Bearer $PRAXIS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "GITHUB_TOKEN", "value": "ghp_example", "allowed_hosts": ["api.github.com"]}'
```

期望：HTTP 200，返回 `type` 为 `vault_secret`、`kind` 为 `static`、`version` 为 `1` 的对象。响应里没有 `value`：值写入后不会再返回。这个 Secret 只能用在发往 `api.github.com` 的请求上。

## 3. 列出 Secret [#3-列出-secret]

```bash
curl "https://api.deepraxis.ai/vault/v1/vaults/$VAULT_ID/secrets" \
  -H "Authorization: Bearer $PRAXIS_API_KEY"
```

期望：HTTP 200，`data` 中有一项，`name` 为 `GITHUB_TOKEN`；`next_cursor` 为 `null`。

## 清理 [#清理]

```bash
curl -X POST "https://api.deepraxis.ai/vault/v1/vaults/$VAULT_ID/archive" \
  -H "Authorization: Bearer $PRAXIS_API_KEY"

curl -X DELETE "https://api.deepraxis.ai/vault/v1/vaults/$VAULT_ID" \
  -H "Authorization: Bearer $PRAXIS_API_KEY"
```

期望：归档返回 HTTP 200、`status: "archived"`，随后删除返回 HTTP 200、`{"id": "<VAULT_ID>", "type": "vault_deleted"}`。删除会一并删除库中的全部 Secret，不可恢复。

[从模板开始、导入 .env 与一键授权 →](/docs/cloud/services/vault/concepts) · [完整请求与对象 →](/docs/api/native/vault)