Skip to content
Cloudflare API
Start here
API Reference

Csam Scanner

Get CSAM Scanner setting
csam_scanner.get(CsamScannerGetParams**kwargs) -> CsamScannerGetResponse
GET/zones/{zone_id}/settings/csam_scanner_third_party
Update CSAM Scanner setting
csam_scanner.edit(CsamScannerEditParams**kwargs) -> CsamScannerEditResponse
PATCH/zones/{zone_id}/settings/csam_scanner_third_party
ModelsExpand Collapse
class CsamScannerGetResponse: …

CSAM Scanner configuration for a zone.

id: Optional[Literal["csam_scanner"]]

The feature identifier.

editable: Optional[bool]

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

modified_on: Optional[datetime]

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

formatdate-time
value: Optional[Value]

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

email: Optional[str]

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

maxLength254
email_state: Optional[Literal["valid", "pending", "unverified"]]

Current verification state of the notification email.

One of the following:
"valid"
"pending"
"unverified"
enabled: Optional[bool]

Whether CSAM scanning is enabled for this zone.

sources: Optional[Dict[str, bool]]

Map of scanning sources and their enabled state.

zone_plan: Optional[str]

The zone’s plan level.

class CsamScannerEditResponse: …

CSAM Scanner configuration for a zone.

id: Optional[Literal["csam_scanner"]]

The feature identifier.

editable: Optional[bool]

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

modified_on: Optional[datetime]

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

formatdate-time
value: Optional[Value]

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

email: Optional[str]

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

maxLength254
email_state: Optional[Literal["valid", "pending", "unverified"]]

Current verification state of the notification email.

One of the following:
"valid"
"pending"
"unverified"
enabled: Optional[bool]

Whether CSAM scanning is enabled for this zone.

sources: Optional[Dict[str, bool]]

Map of scanning sources and their enabled state.

zone_plan: Optional[str]

The zone’s plan level.