← Dokumentace WAF / detections / leaked-credentials

Běžná volání API

Následující příklady řeší běžné scénáře použití API Cloudflare pro správu a konfiguraci detekce uniklých přihlašovacích údajů.

Pokud používáte Terraform, přečtěte si Příklady konfigurace Terraformu.

Obecné operace

Následující ukázky API pokrývají základní operace, jako je zapnutí a vypnutí detekce uniklých přihlašovacích údajů.

Zapnutí detekce uniklých přihlašovacích údajů

Chcete-li zapnout detekci uniklých přihlašovacích údajů, použijte POST požadavek podobný tomuto:

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

Alespoň jeden z následujících oprávnění tokenu je povinné:

Zone WAF Write
Account WAF Write

Aktualizuje stav Leaked Credential Checks pro zónu.

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/leaked-credential-checks" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"enabled": true
	}'

Vypnutí detekce uniklých přihlašovacích údajů

Chcete-li vypnout detekci uniklých přihlašovacích údajů, použijte POST požadavek podobný tomuto:

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

Alespoň jeden z následujících oprávnění tokenu je povinné:

Zone WAF Write
Account WAF Write

Aktualizuje stav Leaked Credential Checks pro zónu.

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/leaked-credential-checks" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"enabled": false
	}'

Získání stavu detekce uniklých přihlašovacích údajů

Chcete-li zjistit aktuální stav detekce uniklých přihlašovacích údajů, použijte GET požadavek podobný tomuto:

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

Alespoň jeden z následujících oprávnění tokenu je povinné:

Zone WAF Write
Zone WAF Read
Account WAF Write
Account WAF Read

Získání stavu Leaked Credential Checks pro zónu.

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/leaked-credential-checks" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
	"result": {
		"enabled": true
	},
	"success": true,
	"errors": [],
	"messages": []
}

Operace s vlastním umístěním detekce

Následující ukázky API pokrývají operace s vlastní umístění detekce pro detekci uniklých přihlašovacích údajů.

Přidat vlastní umístění detekce

Chcete-li přidat vlastní umístění detekce, použijte POST požadavek podobný tomuto:

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

Alespoň jeden z následujících oprávnění tokenu je povinné:

Zone WAF Write
Account WAF Write

Vytvoření vlastního umístění detekce pro zónu.

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/leaked-credential-checks/detections" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"username": "lookup_json_string(http.request.body.raw, \"user\")",
		"password": "lookup_json_string(http.request.body.raw, \"secret\")"
	}'

Získání existujících vlastních umístění detekce

Chcete-li získat seznam existujících vlastních míst detekce, použijte GET požadavek podobný tomuto:

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

Alespoň jeden z následujících oprávnění tokenu je povinné:

Zone WAF Write
Zone WAF Read
Account WAF Write
Account WAF Read

Vypište vlastní umístění detekce dané zóny.

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/leaked-credential-checks/detections" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
	"result": [
		{
			"id": "<DETECTION_ID>",
			"username": "lookup_json_string(http.request.body.raw, \"user\")",
			"password": "lookup_json_string(http.request.body.raw, \"secret\")"
		}
		// (...)
	],
	"success": true,
	"errors": [],
	"messages": []
}

Odstranění vlastního umístění detekce

Chcete-li odstranit vlastní místo detekce, použijte DELETE požadavek podobný tomuto:

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

Alespoň jeden z následujících oprávnění tokenu je povinné:

Zone WAF Write
Account WAF Write

Odstranění vlastního umístění detekce ze zóny.

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/leaked-credential-checks/detections/$DETECTION_ID" \
	--request DELETE \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"