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

[Skip to content](#_top)

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

[Csam Scanner](https://developers.cloudflare.com/api/go/resources/csam_scanner)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Get CSAM Scanner setting

client.CsamScanner.Get(ctx, query) (\*[CsamScannerGetResponse](<https://developers.cloudflare.com/api/go/resources/csam_scanner#(resource)%20csam_scanner%20%3E%20(model)%20CsamScannerGetResponse%20%3E%20(schema)>), error)

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

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**<code>X-Auth-Email: user@example.com</code>

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### Accepted Permissions (at least one required)

`Zone Settings Read`

##### ParametersExpand Collapse

<details>

<summary>

query CsamScannerGetParams

</summary>

ZoneID param.Field\[string]

Identifier for the zone.

maxLength32

minLength1

<a href="#(resource)%20csam_scanner%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20zone_id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20csam_scanner%20%3E%20(method)%20get%20%3E%20(params)%20default>)

##### ReturnsExpand Collapse

<details>

<summary>

type CsamScannerGetResponse struct{…}

CSAM Scanner configuration for a zone.

</summary>

ID CsamScannerGetResponseIDOptional

The feature identifier.

<a href="#(resource)%20csam_scanner%20%3E%20(model)%20CsamScannerGetResponse%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

Editable boolOptional

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

<a href="#(resource)%20csam_scanner%20%3E%20(model)%20CsamScannerGetResponse%20%3E%20(schema)%20%3E%20(property)%20editable">Link to this property</a>

ModifiedOn TimeOptional

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

formatdate-time

<a href="#(resource)%20csam_scanner%20%3E%20(model)%20CsamScannerGetResponse%20%3E%20(schema)%20%3E%20(property)%20modified_on">Link to this property</a>

<details>

<summary>

Value CsamScannerGetResponseValueOptional

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

</summary>

Email stringOptional

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

maxLength254

<a href="#(resource)%20csam_scanner%20%3E%20(model)%20CsamScannerGetResponse%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20email">Link to this property</a>

<details>

<summary>

EmailState CsamScannerGetResponseValueEmailStateOptional

Current verification state of the notification email.

</summary>

One of the following:

const CsamScannerGetResponseValueEmailStateValid CsamScannerGetResponseValueEmailState = "valid"

<a href="#(resource)%20csam_scanner%20%3E%20(model)%20CsamScannerGetResponse%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20email_state%20%3E%20(member)%200">Link to this property</a>

const CsamScannerGetResponseValueEmailStatePending CsamScannerGetResponseValueEmailState = "pending"

<a href="#(resource)%20csam_scanner%20%3E%20(model)%20CsamScannerGetResponse%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20email_state%20%3E%20(member)%201">Link to this property</a>

const CsamScannerGetResponseValueEmailStateUnverified CsamScannerGetResponseValueEmailState = "unverified"

<a href="#(resource)%20csam_scanner%20%3E%20(model)%20CsamScannerGetResponse%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20email_state%20%3E%20(member)%202">Link to this property</a>

</details>

<a href="#(resource)%20csam_scanner%20%3E%20(model)%20CsamScannerGetResponse%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20email_state">Link to this property</a>

Enabled boolOptional

Whether CSAM scanning is enabled for this zone.

<a href="#(resource)%20csam_scanner%20%3E%20(model)%20CsamScannerGetResponse%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20enabled">Link to this property</a>

Sources map\[string, bool]Optional

Map of scanning sources and their enabled state.

<a href="#(resource)%20csam_scanner%20%3E%20(model)%20CsamScannerGetResponse%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20sources">Link to this property</a>

ZonePlan stringOptional

The zone’s plan level.

<a href="#(resource)%20csam_scanner%20%3E%20(model)%20CsamScannerGetResponse%20%3E%20(schema)%20%3E%20(property)%20value%20%3E%20(property)%20zone_plan">Link to this property</a>

</details>

<a href="#(resource)%20csam_scanner%20%3E%20(model)%20CsamScannerGetResponse%20%3E%20(schema)%20%3E%20(property)%20value">Link to this property</a>

</details>

[Link to this property](<#(resource)%20csam_scanner%20%3E%20(model)%20CsamScannerGetResponse%20%3E%20(schema)>)

### Get CSAM Scanner setting

Go

HTTPTypeScriptPythonGoTerraform

```
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/csam_scanner"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  csamScanner, err := client.CsamScanner.Get(context.TODO(), csam_scanner.CsamScannerGetParams{
    ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
    }
  }
}
```