---
title: Get CSAM Scanner setting
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Csam Scanner](https://developers.cloudflare.com/api/resources/csam_scanner)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Get CSAM Scanner setting
GET/zones/{zone\_id}/settings/csam\_scanner\_third\_party
Retrieve the current CSAM Scanner configuration for a zone.
The notification email is masked by default in responses.
##### Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
**Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**X-Auth-Email: user@example.com
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required)
`Zone Settings Read`
##### P ath ParametersExpand Collapse
zone\_id: string
Identifier for the zone.
maxLength32
minLength1
[Link to this property](<#(resource)%20csam_scanner%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20csam_scanner%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20csam_scanner%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
success: boolean
Whether the API call was successful.
[Link to this property](<#(resource)%20csam_scanner%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result: optional object {id, editable, modified\_on, value }
CSAM Scanner configuration for a zone.
id: optional "csam\_scanner"
The feature identifier.
Link to this property
editable: optional 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: optional string
When the setting was last modified. Currently always null as the server does not populate this field.
formatdate-time
Link to this property
value: optional object {email, email\_state, enabled, 2 more }
The CSAM Scanner feature configuration values. Contains the notification email and scanning enablement settings.
email: optional string
Notification email address for CSAM scan results. Masked in responses unless explicitly unmasked via admin endpoint.
maxLength254
Link to this property
email\_state: optional "valid"or "pending"or "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: optional boolean
Whether CSAM scanning is enabled for this zone.
Link to this property
sources: optional map\[boolean]
Map of scanning sources and their enabled state.
Link to this property
zone\_plan: optional string
The zone’s plan level.
Link to this property
Link to this property
[Link to this property](<#(resource)%20csam_scanner%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
### Get CSAM Scanner setting
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/settings/csam_scanner_third_party \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": {
"id": "csam_scanner",
"editable": true,
"modified_on": "2019-12-27T18:11:19.117Z",
"value": {
"email": "**********",
"email_state": "valid",
"enabled": true,
"sources": {
"source1": true
},
"zone_plan": "ent"
}
}
}
```
##### Returns Examples
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": {
"id": "csam_scanner",
"editable": true,
"modified_on": "2019-12-27T18:11:19.117Z",
"value": {
"email": "**********",
"email_state": "valid",
"enabled": true,
"sources": {
"source1": true
},
"zone_plan": "ent"
}
}
}
```