跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com

常用 API 调用

最后更新 查看 MarkdownAgent 设置

以下示例介绍了使用 Cloudflare API 管理和配置 WAF 内容扫描的常用方案。

如果您使用的是 Terraform,请参阅 Terraform 配置示例。

常规操作

以下 API 示例涵盖了启用和禁用 WAF 内容扫描等基本操作。

启用 WAF 内容扫描

要启用内容扫描,请使用类似于以下的 POST 请求:

Required API token permissions

At least one of the following token permissions is required:
  • Zone WAF Write
  • Account WAF Write
Enable Content Scanning for a zone.bash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/enable" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

禁用 WAF 内容扫描

要禁用内容扫描,请使用类似于以下的 POST 请求:

Required API token permissions

At least one of the following token permissions is required:
  • Zone WAF Write
  • Account WAF Write
Disable Content Scanning for a zone.bash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/disable" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

获取 WAF 内容扫描状态

要获取内容扫描功能的当前状态,请使用类似于以下的 GET 请求:

Required API token permissions

At least one of the following token permissions is required:
  • Zone WAF Write
  • Zone WAF Read
  • Account WAF Write
  • Account WAF Read
Get the Content Scanning status for a zone.bash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/settings" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

自定义扫描表达式操作

以下 API 示例涵盖了针对内容扫描自定义扫描表达式的操作。

获取现有的自定义扫描表达式

要获取现有自定义扫描表达式的列表,请使用类似于以下的 GET 请求:

Required API token permissions

At least one of the following token permissions is required:
  • Zone WAF Write
  • Zone WAF Read
  • Account WAF Write
  • Account WAF Read
List the Content Scanning custom expressions of a zone.bash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/payloads" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
{
	"result": [
		{
			"id": "<EXPRESSION_ID>",
			"payload": "lookup_json_string(http.request.body.raw, \"file\")"
		}
	],
	"success": true,
	"errors": [],
	"messages": []
}

添加自定义扫描表达式

使用类似于以下的 POST 请求:

Required API token permissions

At least one of the following token permissions is required:
  • Zone WAF Write
  • Account WAF Write
Create Content Scanning custom expressions for a zone.bash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/payloads" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '[
		{
				"payload": "lookup_json_string(http.request.body.raw, \"file\")"
		}
	]'

删除自定义扫描表达式

使用类似于以下的 DELETE 请求:

Required API token permissions

At least one of the following token permissions is required:
  • Zone WAF Write
  • Account WAF Write
Delete a Content Scanning custom expression from a zone.bash
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/payloads/$EXPRESSION_ID" \
	--request DELETE \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

这篇文档对您有帮助吗?