# 轮换个人版 API Key

> 全部文档的索引见 [llms.txt](https://ark.volcengine.com/llms.txt)；在任一文档页面地址后追加 `.md` 可获取该页的 Markdown 版本。

`POST https://ark.cn-beijing.volcengineapi.com/?Action=RegeneratePersonalApiKey&Version=2024-01-01`

轮换个人版 `AgentPlan` 套餐的 API Key。轮换后原 API Key 立即失效，使用旧 Key 的请求将鉴权失败。轮换成功后，请通过控制台或调用 [获取临时 API Key](/docs/get-api-key-api) 接口获取新 API Key，本接口出于安全考虑不在响应体中返回新 Key。适用于密钥泄露后的紧急轮换或定期安全轮换场景。

> **注意**
>
> 轮换操作不可逆，旧 API Key 在轮换完成后立即失效。请在调用前确认已做好密钥更替的业务联动准备。轮换成功后，请通过控制台或调用 [获取临时 API Key](/docs/get-api-key-api) 获取新 API Key，本接口出于安全考虑不在响应体中返回新 Key。

## 鉴权

本接口支持鉴权方式如下，详情请参见 [Base URL 及鉴权](/docs/base-url-and-authentication)。

* Access Key 鉴权，请在 [Access Key 管理](https://console.volcengine.com/iam/keymanage) 页面，获取 Access Key。本接口仅支持 Access Key 鉴权。

---

<span id="request-parameters"></span>
## 请求参数

### Body 参数

**Plan** `string` `必选` | 商品名称

待轮换 API Key 的套餐商品名称。可选值：`AgentPlan`（Agent Plan 个人版）。

**ProjectName** `string` | 项目名称

API Key 所属的项目空间名称。

## 响应参数

**Message** `string` | 失败原因

轮换失败时的具体原因说明。轮换成功时为空字符串。

**Status** `string` | 轮换结果

轮换结果状态。可选值：`Success`（轮换成功，新 API Key 已生效，旧 Key 已失效）、`Failed`（轮换失败，原 API Key 仍然有效，具体原因见 *Message* 字段）。


## 代码示例

## 默认

### cURL

#### Request

```bash
curl 'https://ark.cn-beijing.volcengineapi.com/?Action=RegeneratePersonalApiKey&Version=2024-01-01' \
  -H 'Content-Type: application/json' \
  -H 'X-Date: <X-Date>' \
  -H 'X-Content-Sha256: <X-Content-Sha256>' \
  -H 'Authorization: HMAC-SHA256 Credential=<AK>/<X-Date>/cn-beijing/ark/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=<Signature>' \
  -d '{
  "Plan": "AgentPlan"
}
'
```

#### Response

```
{
  "ResponseMetadata": {
    "RequestId": "20260519103356E1B4A72F9D82C50376",
    "Action": "RegeneratePersonalApiKey",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "Status": "Success",
    "Message": ""
  }
}
```
