Update the Content Scanning status for a zone.

client.contentScanning.update(, ?): ContentScanningUpdateResponse { modified, value }

PUT/zones/{zone_id}/content-upload-scan/settings

Update the Content Scanning status by setting the status value to enabled or disabled. This is equivalent to calling the dedicated enable and disable endpoints.

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

params: ContentScanningUpdateParams { zone_id, value }

zone_id: string

Path param: Defines an identifier.

maxLength32

value: "enabled" | "disabled"

Body param: The status value for Content Scanning.

One of the following:

"enabled"

"disabled"

ReturnsExpand Collapse

ContentScanningUpdateResponse { modified, value }

Defines the status for Content Scanning.

modified?: string

Defines the last modification date (ISO 8601) of the Content Scanning status.

value?: string

Defines the status of Content Scanning.

Update the Content Scanning status for a zone.

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const contentScanning = await client.contentScanning.update({
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
  value: 'enabled',
});

console.log(contentScanning.modified);

{
  "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": {
    "modified": "2024-12-02T09:57:23.150259Z",
    "value": "enabled"
  },
  "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": {
    "modified": "2024-12-02T09:57:23.150259Z",
    "value": "enabled"
  },
  "success": true
}