コンテンツにスキップ

一般的なAPI呼び出し

必要なAPIトークンの権限

WAFコンテンツスキャンとカスタムスキャン式を管理するためにAPIリクエストで使用されるAPIトークンは、以下のいずれかの権限を持っている必要があります:

  • zone waf edit
  • account waf edit

一般的な操作

以下のAPIの例は、WAFコンテンツスキャンの有効化と無効化などの基本的な操作をカバーしています。

WAFコンテンツスキャンの有効化

コンテンツスキャンを有効にするには、以下のようなPOSTリクエストを使用します:

リクエストの例
curl --request POST \
"https://api.cloudflare.com/client/v4/zones/{zone_id}/content-upload-scan/enable" \
--header "Authorization: Bearer <API_TOKEN>"

WAFコンテンツスキャンの無効化

コンテンツスキャンを無効にするには、以下のようなPOSTリクエストを使用します:

リクエストの例
curl --request POST \
"https://api.cloudflare.com/client/v4/zones/{zone_id}/content-upload-scan/disable" \
--header "Authorization: Bearer <API_TOKEN>"

WAFコンテンツスキャンのステータス取得

コンテンツスキャン機能の現在のステータスを取得するには、以下のようなGETリクエストを使用します:

リクエストの例
curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/content-upload-scan/settings" \
--header "Authorization: Bearer <API_TOKEN>"

カスタム式操作

以下のAPIの例は、コンテンツスキャンのためのカスタムスキャン式に関する操作をカバーしています。

既存のカスタムスキャン式の取得

既存のカスタムスキャン式のリストを取得するには、以下のようなGETリクエストを使用します:

リクエストの例
curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/content-upload-scan/payloads" \
--header "Authorization: Bearer <API_TOKEN>"
レスポンスの例
{
"result": [
{
"id": "<EXPRESSION_ID>",
"payload": "lookup_json_string(http.request.body.raw, \"file\")"
}
],
"success": true,
"errors": [],
"messages": []
}

カスタムスキャン式の追加

以下のようなPOSTリクエストを使用します:

リクエストの例
curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/content-upload-scan/payloads" \
--header "Authorization: Bearer <API_TOKEN>" \
--header "Content-Type: application/json" \
--data '[
{
"payload": "lookup_json_string(http.request.body.raw, \"file\")"
}
]'

カスタムスキャン式の削除

以下のようなDELETEリクエストを使用します:

リクエストの例
curl --request DELETE \
"https://api.cloudflare.com/client/v4/zones/{zone_id}/content-upload-scan/payloads/{expression_id}" \
--header "Authorization: Bearer <API_TOKEN>"