INTEGRITY Dokumentace

← Dokumentace WAF / detections / leaked-credentials

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 detekce uniklých přihlašovacích údajů.

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í detekce uniklých přihlašovacích údajů.

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

Chcete-li detekci uniklých přihlašovacích údajů zapnout, 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:
Aktualizujte 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 detekci uniklých přihlašovacích údajů vypnout, 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:
Aktualizujte 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ů

Pro zjištění aktuálního stavu detekce uniklých přihlašovacích údajů 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ískejte stav 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 vlastního umístění detekce

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

Přidání vlastního umístění detekce

K přidání vlastního umístění detekce 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í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

Pro získání seznamu existujících vlastních umístění detekce 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 umístění detekce 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

Vlastní umístění detekce smažete pomocí 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:
Smazá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"