INTEGRITY Dokumentace

← Dokumentace WAF / detections / malicious-uploads

Běžná volání API

Následující příklady pokrývají běžné scénáře použití Cloudflare API pro správu a konfiguraci skenování obsahu WAF.

Pokud používáte Terraform, viz Příklady Terraform konfigurace.

Obecné operace

Následující příklady API pokrývají základní operace, jako je zapnutí a vypnutí skenování obsahu WAF.

Zapnutí skenování obsahu WAF

K zapnutí skenování obsahu použijte POST požadavek podobný následujícímu:

Požadovaná oprávnění API tokenu

Alespoň jedno z následujících oprávnění tokenu je vyžadováno:
Zapne Content Scanning pro zónu.
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/enable" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

Zakázání skenování obsahu WAF

Pro zakázání skenování obsahu použijte POST požadavek podobný následujícímu:

Požadovaná oprávnění API tokenu

Alespoň jedno z následujících oprávnění tokenu je vyžadováno:
Vypnutí Content Scanningu pro zónu.
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/disable" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

Získání stavu WAF content scanningu

K získání aktuálního stavu funkce skenování obsahu použijte GET požadavek podobný následujícímu:

Požadovaná oprávnění API tokenu

Alespoň jedno z následujících oprávnění tokenu je vyžadováno:
Získá stav Content Scanningu pro zónu.
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/settings" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

Operace s vlastními výrazy

Následující příklady API pokrývají operace s vlastními výrazy pro skenování v rámci content scanningu.

Získání existujících vlastních výrazů pro skenování

Pro získání seznamu existujících vlastních skenovacích výrazů použijte GET požadavek podobný následujícímu:

Požadovaná oprávnění API tokenu

Alespoň jedno z následujících oprávnění tokenu je vyžadováno:
Výpis vlastních výrazů Content Scanningu zóny.
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": []
}

Přidání vlastního skenovacího výrazu

Použijte POST požadavek podobný následujícímu:

Požadovaná oprávnění API tokenu

Alespoň jedno z následujících oprávnění tokenu je vyžadováno:
Vytvoření vlastních výrazů Content Scanningu pro zónu.
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\")"
		}
	]'

Smazání vlastního skenovacího výrazu

Použijte DELETE požadavek podobný následujícímu:

Požadovaná oprávnění API tokenu

Alespoň jedno z následujících oprávnění tokenu je vyžadováno:
Odstraní vlastní výraz Content Scanning ze zóny.
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/payloads/$EXPRESSION_ID" \
	--request DELETE \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"