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

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

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

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

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

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

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

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

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

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

Хотя бы одно из следующих разрешения токена обязательно:
Обновление статуса 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-токена

Хотя бы одно из следующих разрешения токена обязательно:
Обновление статуса 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-токена

Хотя бы одно из следующих разрешения токена обязательно:
Получение статуса 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-токена

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

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

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