Csam Scanner

Get CSAM Scanner setting

client.csamScanner.get(, ?): CsamScannerGetResponse { id, editable, modified_on, value }

GET/zones/{zone_id}/settings/csam_scanner_third_party

Update CSAM Scanner setting

client.csamScanner.edit(, ?): 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.

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 }