跳转到内容
搜索文档

创建 API 令牌

最后更新 查看 MarkdownAgent 设置
  1. 确定您需要的是用户令牌还是账户 API 令牌。如果您希望使用不与用户关联的服务令牌,且所需的 API 端点兼容,请使用账户 API 令牌。

  2. Cloudflare 仪表板中,用户令牌请前往 My Profile(我的个人资料) > API Tokens(API 令牌);账户令牌请前往 Manage Account(管理账户) > API Tokens(API 令牌)

  3. 选择 Create Token(创建令牌)

  4. 从可用的 API 令牌模板中选择一个模板,或创建自定义令牌。以下示例使用 Edit zone DNS(编辑区域 DNS) 模板。

  5. 添加或编辑令牌名称,以说明该令牌的用途。模板会预填令牌名称和权限。

    令牌模板概览屏幕
  6. 修改令牌的权限。选择权限组(AccountUserZone)后,选择授予该令牌的访问级别。大多数组提供 EditRead 选项。Edit 表示完整的 CRUDL(创建、读取、更新、删除、列出)访问权限,而 Read 表示读取权限,并在适用时包含列出权限。有关更多信息,请参阅可用的令牌权限

  7. 选择该令牌有权访问的资源。例如,为 zone example.com 授予 Zone DNS Read 访问权限后,该令牌只能读取该特定 zone 的 DNS 记录。其他 zone 的 DNS 记录读取操作将返回错误。该 zone 上的其他操作也会返回错误。

  8. (可选)在 Client IP Address Filtering(客户端 IP 地址过滤)TTL (time to live)(生存时间) 字段中限制令牌的使用方式。

  9. 选择 Continue to summary(继续查看摘要)

  10. 查看令牌摘要。选择 Edit token(编辑令牌) 进行调整。您也可以在创建后编辑令牌。

显示所选资源和权限的令牌摘要屏幕
  1. 选择 Create Token(创建令牌) 以生成令牌的密钥。
  2. 将密钥复制到安全位置。
显示 API 令牌及用于测试令牌的 curl 命令的令牌创建完成屏幕

令牌密钥页面还包含用于测试该令牌的示例命令。使用 /user/tokens/verify 端点获取给定令牌的当前状态。

curl "https://api.cloudflare.com/client/v4/user/tokens/verify" \
--header "Authorization: Bearer <API_TOKEN>"

结果:

{
	"result": {
		"id": "100bf38cc8393103870917dd535e0628",
		"status": "active"
	},
	"success": true,
	"errors": [],
	"messages": [
		{
			"code": 10000,
			"message": "This API Token is valid and active",
			"type": null
		}
	]
}

新的 API 令牌使用带 cfut_ 前缀的可扫描格式,便于凭证扫描工具检测泄露的令牌。

至此,您已成功创建 API 令牌,可以开始使用 Cloudflare API。创建第一个 API 令牌后,您还可以通过 API 创建更多 API 令牌。

这篇文档对您有帮助吗?