---
title: Csam Scanner
---

[Skip to content](#%5Ftop) 

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

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Csam Scanner

##### [Get CSAM Scanner setting](https://developers.cloudflare.com/api/typescript/resources/csam%5Fscanner/methods/get)

client.csamScanner.get(CsamScannerGetParams { zone\_id } params, RequestOptionsoptions?): [CsamScannerGetResponse](https://developers.cloudflare.com/api/typescript/resources/csam%5Fscanner#%28resource%29%20csam%5Fscanner%20%3E%20%28model%29%20csam%5Fscanner%5Fget%5Fresponse%20%3E%20%28schema%29) { id, editable, modified\_on, value } 

GET/zones/{zone\_id}/settings/csam\_scanner\_third\_party

##### [Update CSAM Scanner setting](https://developers.cloudflare.com/api/typescript/resources/csam%5Fscanner/methods/edit)

client.csamScanner.edit(CsamScannerEditParams { zone\_id, id, value } params, RequestOptionsoptions?): [CsamScannerEditResponse](https://developers.cloudflare.com/api/typescript/resources/csam%5Fscanner#%28resource%29%20csam%5Fscanner%20%3E%20%28model%29%20csam%5Fscanner%5Fedit%5Fresponse%20%3E%20%28schema%29) { id, editable, modified\_on, value } 

PATCH/zones/{zone\_id}/settings/csam\_scanner\_third\_party

##### ModelsExpand Collapse 

CsamScannerGetResponse { id, editable, modified\_on, value } 

CSAM Scanner configuration for a zone.

id?: "csam\_scanner"

The feature identifier.

editable?: boolean

Whether the feature state can be changed. When false, the zone or account may be locked by Trust & Safety.

modified\_on?: string | null

When the setting was last modified. Currently always null as the server does not populate this field.

formatdate-time

value?: Value { email, email\_state, enabled, 2 more } 

The CSAM Scanner feature configuration values. Contains the notification email and scanning enablement settings.

email?: string

Notification email address for CSAM scan results. Masked in responses unless explicitly unmasked via admin endpoint.

maxLength254

email\_state?: "valid" | "pending" | "unverified"

Current verification state of the notification email.

One of the following:

"valid"

"pending"

"unverified"

enabled?: boolean

Whether CSAM scanning is enabled for this zone.

sources?: Record<string, boolean\>

Map of scanning sources and their enabled state.

zone\_plan?: string

The zone’s plan level.

CsamScannerEditResponse { id, editable, modified\_on, value } 

CSAM Scanner configuration for a zone.

id?: "csam\_scanner"

The feature identifier.

editable?: boolean

Whether the feature state can be changed. When false, the zone or account may be locked by Trust & Safety.

modified\_on?: string | null

When the setting was last modified. Currently always null as the server does not populate this field.

formatdate-time

value?: Value { email, email\_state, enabled, 2 more } 

The CSAM Scanner feature configuration values. Contains the notification email and scanning enablement settings.

email?: string

Notification email address for CSAM scan results. Masked in responses unless explicitly unmasked via admin endpoint.

maxLength254

email\_state?: "valid" | "pending" | "unverified"

Current verification state of the notification email.

One of the following:

"valid"

"pending"

"unverified"

enabled?: boolean

Whether CSAM scanning is enabled for this zone.

sources?: Record<string, boolean\>

Map of scanning sources and their enabled state.

zone\_plan?: string

The zone’s plan level.