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

Включение хранения журналов

По умолчанию журналы HTTP-запросов не хранятся. При первом использовании Logpull API потребуется включить хранение. Отключить хранение можно в любой момент. Обратите внимание, что после отключения хранения ранее сохранённые журналы останутся доступны до истечения срока хранения (см. Срок хранения данных).

Конечные точки

Для управления сроком хранения журналов доступны две конечные точки:

Примеры запросов API с использованием cURL

Проверьте статус хранения журналов

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

Хотя бы одно из следующих права доступа токена требуется:
  • Logs Write
  • Logs Read
Получение флага хранения журналов
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/logs/control/retention/flag" \
	--request GET \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
curl.exe "https://api.cloudflare.com/client/v4/zones/{zone_id}/logs/control/retention/flag" ^
--header "Authorization: Bearer <API_TOKEN>"
$uri = "https://api.cloudflare.com/client/v4/zones/{zone_id}/logs/control/retention/flag"
$headers = @{"Authorization" = "Bearer <API_TOKEN>"}
Invoke-RestMethod -Uri $uri -Method Get -Headers $headers

Если для зоны настроено хранение журналов включено вы получаете значение true, тогда как значение false возвращается, когда disabled.

Включить хранение журналов

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

Хотя бы одно из следующих права доступа токена требуется:
  • Logs Write
Обновление флага хранения журналов
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/logs/control/retention/flag" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"flag": true
	}'
curl.exe "https://api.cloudflare.com/client/v4/zones/{zone_id}/logs/control/retention/flag" ^
--request POST ^
--header "Authorization: Bearer <API_TOKEN>" ^
--header "Content-Type: application/json" ^
--data "{""flag"": true}"
$uri = "https://api.cloudflare.com/client/v4/zones/{zone_id}/logs/control/retention/flag"
$headers = @{"Authorization" = "Bearer <API_TOKEN>"}
$bodyFlag = @{flag = $true} | ConvertTo-Json
Invoke-RestMethod -Uri $uri -Method Post -Headers $headers -Body $bodyFlag -ContentType "application/json"

Ответ (включено)

{
	"flag": true
}

Выключить хранение журналов

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

Хотя бы одно из следующих права доступа токена требуется:
  • Logs Write
Обновление флага хранения журналов
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/logs/control/retention/flag" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"flag": false
	}'
curl.exe "https://api.cloudflare.com/client/v4/zones/{zone_id}/logs/control/retention/flag" ^
--header "Authorization: Bearer <API_TOKEN>" ^
--header "Content-Type: application/json" ^
--data "{""flag"": false}"
$uri = "https://api.cloudflare.com/client/v4/zones/{zone_id}/logs/control/retention/flag"
$headers = @{"Authorization" = "Bearer <API_TOKEN>"}
$bodyFlag = @{flag = $false} | ConvertTo-Json
Invoke-RestMethod -Uri $uri -Method Post -Headers $headers -Body $bodyFlag -ContentType "application/json"

Отключённый ответ

{
	"flag": false
}

Audit

Включение или выключение хранения журналов записывается в Cloudflare Audit Logs.