INTEGRITY Документация

← Документация WAF / detections / malicious-uploads

Типичные вызовы API

Следующие примеры охватывают типичные сценарии использования Cloudflare API для управления сканированием содержимого WAF и его настройки.

Если вы используете Terraform, см. Примеры конфигурации Terraform.

Общие операции

Следующие примеры API охватывают базовые операции — включение и отключение сканирования содержимого WAF.

Включение сканирования содержимого WAF

Чтобы включить сканирование содержимого, используйте POST запрос, аналогичный следующему:

Необходимые разрешения API-токена

Хотя бы одно из следующих разрешения токена обязательно:
Включение Content Scanning для зоны.
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/enable" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

Отключение сканирования содержимого WAF

Чтобы отключить сканирование содержимого, используйте POST запрос, аналогичный следующему:

Необходимые разрешения API-токена

Хотя бы одно из следующих разрешения токена обязательно:
Отключение Content Scanning для зоны.
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/disable" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

Получение статуса сканирования контента WAF

Чтобы получить текущий статус функции сканирования содержимого, используйте GET запрос, аналогичный следующему:

Необходимые разрешения API-токена

Хотя бы одно из следующих разрешения токена обязательно:
Получение статуса Content Scanning для зоны.
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/settings" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

Операции с пользовательскими выражениями

Следующие примеры API охватывают операции с пользовательскими выражениями сканирования для сканирования контента.

Получение существующих пользовательских выражений сканирования

Чтобы получить список существующих пользовательских выражений сканирования, используйте GET запрос, аналогичный следующему:

Необходимые разрешения API-токена

Хотя бы одно из следующих разрешения токена обязательно:
Список пользовательских выражений Content Scanning зоны.
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 запрос, аналогичный следующему:

Необходимые разрешения API-токена

Хотя бы одно из следующих разрешения токена обязательно:
Создание пользовательских выражений Content Scanning для зоны.
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 запрос, аналогичный следующему:

Необходимые разрешения API-токена

Хотя бы одно из следующих разрешения токена обязательно:
Удаление пользовательского выражения Content Scanning из зоны.
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/payloads/$EXPRESSION_ID" \
	--request DELETE \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"