ログ保持を有効にする

デフォルトでは、HTTP リクエストログは保持されません。Logpull API を初めて使うときは、保持を有効にする必要があります。保持はいつでもオフにできます。保持をオフにしたあとでも、以前に保存したログは保持期間が切れるまで利用できます（データ保持期間を参照してください）。

エンドポイント

ログ保持の管理には、次の 2 つのエンドポイントがあります。

GET /logs/control/retention/flag — 保持の現在の状態を返します
POST /logs/control/retention/flag — 保持をオンまたはオフにします

cURL を使った API リクエストの例

ログ保持の状態を確認する

Required API token permissions

At least one of the following token permissions is required:

Logs Write
Logs Read

Get log retention flagbash

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 が返ります。

ログ保持をオンにする

Required API token permissions

At least one of the following token permissions is required:

Logs Write

Update log retention flagbash

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
}

ログ保持をオフにする

Required API token permissions

At least one of the following token permissions is required:

Logs Write

Update log retention flagbash

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
}

監査

ログ保持のオン／オフは Cloudflare Audit Logs に記録されます。