---
title: Get CSAM Scanner setting
---

[Skip to content](#%5Ftop) 

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

[Csam Scanner](https://developers.cloudflare.com/api/typescript/resources/csam%5Fscanner)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Get CSAM Scanner setting

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

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](https://developers.cloudflare.com/fundamentals/api/get-started/create-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`

##### ParametersExpand Collapse 

params: CsamScannerGetParams { zone\_id } 

zone\_id: string

Identifier for the zone.

maxLength32

minLength1

##### ReturnsExpand 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.

### Get CSAM Scanner setting

TypeScript

HTTPHTTP

TypeScriptTypeScript

PythonPython

GoGo

TerraformTerraform

```
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const csamScanner = await client.csamScanner.get({ zone_id: '023e105f4ecef8ad9ca31a8372d0c353' });

console.log(csamScanner.id);
```

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"
    }
  }
}
```