--- title: Csam Scanner --- [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** # Csam Scanner ##### [Get CSAM Scanner setting](https://developers.cloudflare.com/api/typescript/resources/csam_scanner/methods/get) client.csamScanner.get(CsamScannerGetParams {zone\_id } params, RequestOptionsoptions?): [CsamScannerGetResponse]() {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_scanner/methods/edit) client.csamScanner.edit(CsamScannerEditParams {zone\_id, id, value } params, RequestOptionsoptions?): [CsamScannerEditResponse]() {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. Link to this property editable?: boolean Whether the feature state can be changed. When false, the zone or account may be locked by Trust & Safety. Link to this property modified\_on?: string| null When the setting was last modified. Currently always null as the server does not populate this field. formatdate-time Link to this property
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 Link to this property
email\_state?: "valid"| "pending"| "unverified" Current verification state of the notification email. One of the following: "valid" Link to this property "pending" Link to this property "unverified" Link to this property
Link to this property enabled?: boolean Whether CSAM scanning is enabled for this zone. Link to this property sources?: Record<string, boolean> Map of scanning sources and their enabled state. Link to this property zone\_plan?: string The zone’s plan level. Link to this property
Link to this property
[Link to this property](<#(resource)%20csam_scanner%20%3E%20(model)%20csam_scanner_get_response%20%3E%20(schema)>)
CsamScannerEditResponse {id, editable, modified\_on, value } CSAM Scanner configuration for a zone. id?: "csam\_scanner" The feature identifier. Link to this property editable?: boolean Whether the feature state can be changed. When false, the zone or account may be locked by Trust & Safety. Link to this property modified\_on?: string| null When the setting was last modified. Currently always null as the server does not populate this field. formatdate-time Link to this property
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 Link to this property
email\_state?: "valid"| "pending"| "unverified" Current verification state of the notification email. One of the following: "valid" Link to this property "pending" Link to this property "unverified" Link to this property
Link to this property enabled?: boolean Whether CSAM scanning is enabled for this zone. Link to this property sources?: Record<string, boolean> Map of scanning sources and their enabled state. Link to this property zone\_plan?: string The zone’s plan level. Link to this property
Link to this property
[Link to this property](<#(resource)%20csam_scanner%20%3E%20(model)%20csam_scanner_edit_response%20%3E%20(schema)>)