Update a Content Scanning custom expression for a zone.

content_scanning.payloads.update(, ) -> SyncSinglePage[PayloadUpdateResponse]

PATCH/zones/{zone_id}/content-upload-scan/payloads/{expression_id}

Update the Content Scanning custom expression with the given identifier and return the updated list of expressions.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Zone WAF WriteAccount WAF Write

ParametersExpand Collapse

zone_id: str

Defines an identifier.

maxLength32

expression_id: str

Defines the unique ID for this Content Scanning custom expression.

maxLength32

payload: str

Defines the custom content extraction expression used to reach content objects in the request.

ReturnsExpand Collapse

class PayloadUpdateResponse: …

Defines a Content Scanning custom expression.

id: Optional[str]

Defines the unique ID for this Content Scanning custom expression.

maxLength32

payload: Optional[str]

Defines the custom content extraction expression used to reach content objects in the request.

Update a Content Scanning custom expression for a zone.

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.content_scanning.payloads.update(
    expression_id="a350a054caa840c9becd89c3b4f0195b",
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    payload="lookup_json_string(http.request.body.raw, \"file\")",
)
page = page.result[0]
print(page.id)

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "a350a054caa840c9becd89c3b4f0195b",
      "payload": "lookup_json_string(http.request.body.raw, \"file\")"
    }
  ],
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "a350a054caa840c9becd89c3b4f0195b",
      "payload": "lookup_json_string(http.request.body.raw, \"file\")"
    }
  ],
  "success": true
}