跳转到内容
搜索文档

使用 Cloudflare API 创建和管理小组件

最后更新 查看 MarkdownAgent 设置

使用 Cloudflare API 进行编程式的小组件管理和自动化。

前提条件

在开始之前,您必须具备:

  • 具有 Account:Turnstile:Edit 权限的 Cloudflare API 令牌
  • 在您的 Cloudflare 仪表板中找到的账户 ID

通过 API 创建小组件

Required API token permissions

At least one of the following token permissions is required:
  • Turnstile Sites Write
  • Account Settings Write
Create a Turnstile Widgetbash
curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/challenges/widgets" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"domains": [
				"example.com"
		],
		"mode": "managed",
		"name": "My Example Turnstile Widget"
	}'

通过 API 管理小组件

Required API token permissions

At least one of the following token permissions is required:
  • Turnstile Sites Write
  • Turnstile Sites Read
  • Account Settings Write
  • Account Settings Read
List Turnstile Widgetsbash
curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/challenges/widgets" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

Required API token permissions

At least one of the following token permissions is required:
  • Turnstile Sites Write
  • Turnstile Sites Read
  • Account Settings Write
  • Account Settings Read
Turnstile Widget Detailsbash
curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/challenges/widgets/$SITEKEY" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

Required API token permissions

At least one of the following token permissions is required:
  • Turnstile Sites Write
  • Account Settings Write
Update a Turnstile Widgetbash
curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/challenges/widgets/$SITEKEY" \
	--request PUT \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"domains": [
				"203.0.113.1",
				"cloudflare.com",
				"blog.example.com"
		],
		"mode": "invisible",
		"name": "blog.cloudflare.com login form",
		"clearance_level": "interactive"
	}'

Required API token permissions

At least one of the following token permissions is required:
  • Turnstile Sites Write
  • Account Settings Write
Rotate Secret for a Turnstile Widgetbash
curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/challenges/widgets/$SITEKEY/rotate_secret" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"invalidate_immediately": false
	}'

Required API token permissions

At least one of the following token permissions is required:
  • Turnstile Sites Write
  • Account Settings Write
Delete a Turnstile Widgetbash
curl "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/challenges/widgets/$SITEKEY" \
	--request DELETE \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

这篇文档对您有帮助吗?