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

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

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

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

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

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

Включение обнаружения утёкших учётных данных

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

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

Хотя бы одно из следующих права доступа токена требуется:

Zone WAF Write
Account WAF Write

Обновить статус Leaked Credential Checks для зоны.

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

Отключение обнаружения утёкших учётных данных

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

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

Хотя бы одно из следующих права доступа токена требуется:

Zone WAF Write
Account WAF Write

Обновить статус Leaked Credential Checks для зоны.

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

Получить статус обнаружения утекших учётных данных

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

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

Хотя бы одно из следующих права доступа токена требуется:

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

Получить статус Leaked Credential Checks для зоны.

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": []
}

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

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

Добавьте пользовательское место обнаружения

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

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

Хотя бы одно из следующих права доступа токена требуется:

Zone WAF Write
Account WAF Write

Создание пользовательского расположения обнаружения для зоны.

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\")"
	}'

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

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

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

Хотя бы одно из следующих права доступа токена требуется:

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

Выведите список пользовательских мест обнаружения зоны.

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": []
}

Удаление пользовательского места обнаружения

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

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

Хотя бы одно из следующих права доступа токена требуется:

Zone WAF Write
Account WAF Write

Удаление пользовательского места обнаружения из зоны.

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