---
title: Content Scanning
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/typescript)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Content Scanning

##### [Enable Content Scanning for a zone.](https://developers.cloudflare.com/api/typescript/resources/content_scanning/methods/enable)

client.contentScanning.enable(ContentScanningEnableParams {zone\_id } params, RequestOptionsoptions?): [ContentScanningEnableResponse](<https://developers.cloudflare.com/api/typescript/resources/content_scanning#(resource)%20content_scanning%20%3E%20(model)%20content_scanning_enable_response%20%3E%20(schema)>)

POST/zones/{zone\_id}/content-upload-scan/enable

##### [Disable Content Scanning for a zone.](https://developers.cloudflare.com/api/typescript/resources/content_scanning/methods/disable)

client.contentScanning.disable(ContentScanningDisableParams {zone\_id } params, RequestOptionsoptions?): [ContentScanningDisableResponse](<https://developers.cloudflare.com/api/typescript/resources/content_scanning#(resource)%20content_scanning%20%3E%20(model)%20content_scanning_disable_response%20%3E%20(schema)>)

POST/zones/{zone\_id}/content-upload-scan/disable

##### [Update the Content Scanning status for a zone.](https://developers.cloudflare.com/api/typescript/resources/content_scanning/methods/create)

client.contentScanning.create(ContentScanningCreateParams {zone\_id, value } params, RequestOptionsoptions?): [ContentScanningCreateResponse](<https://developers.cloudflare.com/api/typescript/resources/content_scanning#(resource)%20content_scanning%20%3E%20(model)%20content_scanning_create_response%20%3E%20(schema)>) {modified, value }

PUT/zones/{zone\_id}/content-upload-scan/settings

##### [Update the Content Scanning status for a zone.](https://developers.cloudflare.com/api/typescript/resources/content_scanning/methods/update)

client.contentScanning.update(ContentScanningUpdateParams {zone\_id, value } params, RequestOptionsoptions?): [ContentScanningUpdateResponse](<https://developers.cloudflare.com/api/typescript/resources/content_scanning#(resource)%20content_scanning%20%3E%20(model)%20content_scanning_update_response%20%3E%20(schema)>) {modified, value }

PUT/zones/{zone\_id}/content-upload-scan/settings

##### [Get the Content Scanning status for a zone.](https://developers.cloudflare.com/api/typescript/resources/content_scanning/methods/get)

client.contentScanning.get(ContentScanningGetParams {zone\_id } params, RequestOptionsoptions?): [ContentScanningGetResponse](<https://developers.cloudflare.com/api/typescript/resources/content_scanning#(resource)%20content_scanning%20%3E%20(model)%20content_scanning_get_response%20%3E%20(schema)>) {modified, value }

GET/zones/{zone\_id}/content-upload-scan/settings

##### ModelsExpand Collapse

ContentScanningEnableResponse = unknown

[Link to this property](<#(resource)%20content_scanning%20%3E%20(model)%20content_scanning_enable_response%20%3E%20(schema)>)

ContentScanningDisableResponse = unknown

[Link to this property](<#(resource)%20content_scanning%20%3E%20(model)%20content_scanning_disable_response%20%3E%20(schema)>)

<details>

<summary>

ContentScanningCreateResponse {modified, value }

Defines the status for Content Scanning.

</summary>

modified?: string

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

<a href="#(resource)%20content_scanning%20%3E%20(model)%20content_scanning_create_response%20%3E%20(schema)%20%3E%20(property)%20modified">Link to this property</a>

value?: string

Defines the status of Content Scanning.

<a href="#(resource)%20content_scanning%20%3E%20(model)%20content_scanning_create_response%20%3E%20(schema)%20%3E%20(property)%20value">Link to this property</a>

</details>

[Link to this property](<#(resource)%20content_scanning%20%3E%20(model)%20content_scanning_create_response%20%3E%20(schema)>)

<details>

<summary>

ContentScanningUpdateResponse {modified, value }

Defines the status for Content Scanning.

</summary>

modified?: string

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

<a href="#(resource)%20content_scanning%20%3E%20(model)%20content_scanning_update_response%20%3E%20(schema)%20%3E%20(property)%20modified">Link to this property</a>

value?: string

Defines the status of Content Scanning.

<a href="#(resource)%20content_scanning%20%3E%20(model)%20content_scanning_update_response%20%3E%20(schema)%20%3E%20(property)%20value">Link to this property</a>

</details>

[Link to this property](<#(resource)%20content_scanning%20%3E%20(model)%20content_scanning_update_response%20%3E%20(schema)>)

<details>

<summary>

ContentScanningGetResponse {modified, value }

Defines the status for Content Scanning.

</summary>

modified?: string

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

<a href="#(resource)%20content_scanning%20%3E%20(model)%20content_scanning_get_response%20%3E%20(schema)%20%3E%20(property)%20modified">Link to this property</a>

value?: string

Defines the status of Content Scanning.

<a href="#(resource)%20content_scanning%20%3E%20(model)%20content_scanning_get_response%20%3E%20(schema)%20%3E%20(property)%20value">Link to this property</a>

</details>

[Link to this property](<#(resource)%20content_scanning%20%3E%20(model)%20content_scanning_get_response%20%3E%20(schema)>)

#### Content ScanningPayloads

##### [List the Content Scanning custom expressions of a zone.](https://developers.cloudflare.com/api/typescript/resources/content_scanning/subresources/payloads/methods/list)

client.contentScanning.payloads.list(PayloadListParams {zone\_id } params, RequestOptionsoptions?): SinglePage< [PayloadListResponse](<https://developers.cloudflare.com/api/typescript/resources/content_scanning#(resource)%20content_scanning.payloads%20%3E%20(model)%20payload_list_response%20%3E%20(schema)>) {id, payload } >

GET/zones/{zone\_id}/content-upload-scan/payloads

##### [Create Content Scanning custom expressions for a zone.](https://developers.cloudflare.com/api/typescript/resources/content_scanning/subresources/payloads/methods/create)

client.contentScanning.payloads.create(PayloadCreateParams {zone\_id, body } params, RequestOptionsoptions?): SinglePage< [PayloadCreateResponse](<https://developers.cloudflare.com/api/typescript/resources/content_scanning#(resource)%20content_scanning.payloads%20%3E%20(model)%20payload_create_response%20%3E%20(schema)>) {id, payload } >

POST/zones/{zone\_id}/content-upload-scan/payloads

##### [Delete a Content Scanning custom expression from a zone.](https://developers.cloudflare.com/api/typescript/resources/content_scanning/subresources/payloads/methods/delete)

client.contentScanning.payloads.delete(stringexpressionID, PayloadDeleteParams {zone\_id } params, RequestOptionsoptions?): SinglePage< [PayloadDeleteResponse](<https://developers.cloudflare.com/api/typescript/resources/content_scanning#(resource)%20content_scanning.payloads%20%3E%20(model)%20payload_delete_response%20%3E%20(schema)>) {id, payload } >

DELETE/zones/{zone\_id}/content-upload-scan/payloads/{expression\_id}

##### [Update a Content Scanning custom expression for a zone.](https://developers.cloudflare.com/api/typescript/resources/content_scanning/subresources/payloads/methods/update)

client.contentScanning.payloads.update(stringexpressionID, PayloadUpdateParams {zone\_id, payload } params, RequestOptionsoptions?): SinglePage< [PayloadUpdateResponse](<https://developers.cloudflare.com/api/typescript/resources/content_scanning#(resource)%20content_scanning.payloads%20%3E%20(model)%20payload_update_response%20%3E%20(schema)>) {id, payload } >

PATCH/zones/{zone\_id}/content-upload-scan/payloads/{expression\_id}

##### ModelsExpand Collapse

<details>

<summary>

PayloadListResponse {id, payload }

Defines a Content Scanning custom expression.

</summary>

id?: string

Defines the unique ID for this Content Scanning custom expression.

maxLength32

<a href="#(resource)%20content_scanning.payloads%20%3E%20(model)%20payload_list_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

payload?: string

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

<a href="#(resource)%20content_scanning.payloads%20%3E%20(model)%20payload_list_response%20%3E%20(schema)%20%3E%20(property)%20payload">Link to this property</a>

</details>

[Link to this property](<#(resource)%20content_scanning.payloads%20%3E%20(model)%20payload_list_response%20%3E%20(schema)>)

<details>

<summary>

PayloadCreateResponse {id, payload }

Defines a Content Scanning custom expression.

</summary>

id?: string

Defines the unique ID for this Content Scanning custom expression.

maxLength32

<a href="#(resource)%20content_scanning.payloads%20%3E%20(model)%20payload_create_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

payload?: string

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

<a href="#(resource)%20content_scanning.payloads%20%3E%20(model)%20payload_create_response%20%3E%20(schema)%20%3E%20(property)%20payload">Link to this property</a>

</details>

[Link to this property](<#(resource)%20content_scanning.payloads%20%3E%20(model)%20payload_create_response%20%3E%20(schema)>)

<details>

<summary>

PayloadDeleteResponse {id, payload }

Defines a Content Scanning custom expression.

</summary>

id?: string

Defines the unique ID for this Content Scanning custom expression.

maxLength32

<a href="#(resource)%20content_scanning.payloads%20%3E%20(model)%20payload_delete_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

payload?: string

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

<a href="#(resource)%20content_scanning.payloads%20%3E%20(model)%20payload_delete_response%20%3E%20(schema)%20%3E%20(property)%20payload">Link to this property</a>

</details>

[Link to this property](<#(resource)%20content_scanning.payloads%20%3E%20(model)%20payload_delete_response%20%3E%20(schema)>)

<details>

<summary>

PayloadUpdateResponse {id, payload }

Defines a Content Scanning custom expression.

</summary>

id?: string

Defines the unique ID for this Content Scanning custom expression.

maxLength32

<a href="#(resource)%20content_scanning.payloads%20%3E%20(model)%20payload_update_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

payload?: string

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

<a href="#(resource)%20content_scanning.payloads%20%3E%20(model)%20payload_update_response%20%3E%20(schema)%20%3E%20(property)%20payload">Link to this property</a>

</details>

[Link to this property](<#(resource)%20content_scanning.payloads%20%3E%20(model)%20payload_update_response%20%3E%20(schema)>)

#### Content ScanningSettings

##### [Get the Content Scanning status for a zone.](https://developers.cloudflare.com/api/typescript/resources/content_scanning/subresources/settings/methods/get)

client.contentScanning.settings.get(SettingGetParams {zone\_id } params, RequestOptionsoptions?): [SettingGetResponse](<https://developers.cloudflare.com/api/typescript/resources/content_scanning#(resource)%20content_scanning.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)>) {modified, value }

GET/zones/{zone\_id}/content-upload-scan/settings

##### ModelsExpand Collapse

<details>

<summary>

SettingGetResponse {modified, value }

Defines the status for Content Scanning.

</summary>

modified?: string

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

<a href="#(resource)%20content_scanning.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)%20%3E%20(property)%20modified">Link to this property</a>

value?: string

Defines the status of Content Scanning.

<a href="#(resource)%20content_scanning.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)%20%3E%20(property)%20value">Link to this property</a>

</details>

[Link to this property](<#(resource)%20content_scanning.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)>)