跳到主要内容
版本:latest

获取 Cloudflare API Key 和 API Token

本教程介绍如何获取 Cloudflare 的 Global API Key 和 API Token,这些凭证在以下场景中需要使用:

  • SSL 证书自动化申请:使用 DNS 验证方式申请 Let's Encrypt 等证书时,需要通过 API 自动添加 DNS 记录
  • Cloudflare 插件配置:宝塔面板的 Cloudflare 插件需要 API 凭证来管理 DNS 记录和其他功能

API Key 与 API Token 的区别

类型权限范围安全性适用场景
Global API Key账户下所有域名的完全访问权限较低(权限过大)旧版集成、兼容性需求
API Token可自定义权限和域名范围较高(最小权限原则)推荐使用,更安全
推荐

优先使用 API Token,可以限制权限范围,更加安全。只有在不支持 Token 的情况下才使用 Global API Key。

获取 Global API Key

说明

Global API Key 通常配合账号邮箱一起使用,如果您在面板功能中看到需要填写 EmailAPI Key两种信息,则表示需要使用 Global API Key。

1. 打开 API Tokens 页面

访问 Cloudflare API Tokens 页面并登录您的账户。

2. 查看 Global API Key

在页面底部找到 Global API Key 部分,点击 View(查看)按钮。 查看 Global API Key 按钮

系统可能会要求您完成进行验证。

3. 复制 API Key

验证通过后,Global API Key 会显示出来,点击复制保存。 显示的 Global API Key

安全提示
  • Global API Key 拥有您账户下所有域名的完全控制权限
  • 请妥善保管,不要泄露给他人
  • 如果怀疑泄露,请立即在 Cloudflare 中重新生成

获取 API Token(推荐)

说明

如果您在面板功能中看到仅需要填写 API Token(API 令牌),则表示需要使用 API Token。

1. 打开 API Tokens 页面

访问 Cloudflare 帐户 API 令牌 页面并登录您的账户。

2. 创建 Token

点击 Create Token(创建令牌)按钮。 创建 API Token 按钮

3. 选择模板或自定义

Cloudflare 提供了多个预设模板,我们选择:

选择 Edit zone DNS(编辑区域 DNS) 模板,或自定义配置: 选择编辑区域 DNS 模板

4. 设置 Token 名称和权限

为 Token 设置一个描述性的名称,如 BaoTa-Panel-DNS,并配置权限: 设置 Token 名称和权限

  • Permissions(权限):选择 Zone(区域) 下的 DNS,操作权限选择 Edit(编辑)
  • Zone Resources(区域资源):选择 Include(包含) → Specific zone(特定区域),然后选择您要管理的域名
  • 其他选项保持默认,或根据需要调整

::: info 说明 如您在插件中使用,建议选择:择 Zone(区域) 下的 Zone(区域),操作权限选择 Edit(编辑),以确保插件功能完整。 设置 Zone 编辑权限 :::

5. 创建并保存 Token

点击 Continue to summary(继续以显示摘要) Token 创建摘要

确认信息无误后点击 Create Token(创建令牌)创建 API Token 按钮

重要

Token 只会显示一次!请立即复制并安全保存。如果丢失,需要重新创建。 显示的 API Token

在宝塔面板中使用

SSL 证书申请(DNS 验证)

  1. 进入 网站SSLLet's Encrypt
  2. 验证方式选择 DNS 验证
  3. DNS 接口选择 Cloudflare
  4. 填写:
    • Cloudflare Email:您的 Cloudflare 登录邮箱
    • API KeyAPI Token:填写对应的凭证

Cloudflare 插件配置

  1. 进入 软件商店 → 安装 Cloudflare 插件
  2. 打开插件设置
  3. 填写 API 凭证:
    • 如使用 Global API Key:填写邮箱和 API Key
    • 如使用 API Token:直接填写 Token