# Content Scanning

## Enable Content Scanning

**post** `/zones/{zone_id}/content-upload-scan/enable`

Enable Content Scanning.

### Path Parameters

- `zone_id: string`

  Defines an identifier.

### Returns

- `errors: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

    - `pointer: optional string`

- `messages: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

- `result: unknown`

- `success: true`

  Whether the API call was successful.

  - `true`

### Example

```http
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/enable \
    -X POST \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {},
  "success": true
}
```

## Disable Content Scanning

**post** `/zones/{zone_id}/content-upload-scan/disable`

Disable Content Scanning.

### Path Parameters

- `zone_id: string`

  Defines an identifier.

### Returns

- `errors: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

    - `pointer: optional string`

- `messages: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

- `result: unknown`

- `success: true`

  Whether the API call was successful.

  - `true`

### Example

```http
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/disable \
    -X POST \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {},
  "success": true
}
```

## Update Content Scanning Status

**put** `/zones/{zone_id}/content-upload-scan/settings`

Update the Content Scanning status.

### Path Parameters

- `zone_id: string`

  Defines an identifier.

### Body Parameters

- `value: "enabled" or "disabled"`

  The status value for Content Scanning.

  - `"enabled"`

  - `"disabled"`

### Returns

- `errors: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

    - `pointer: optional string`

- `messages: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

- `result:  { modified, value }`

  Defines the status for Content Scanning.

  - `modified: optional string`

    Defines the last modification date (ISO 8601) of the Content Scanning status.

  - `value: optional string`

    Defines the status of Content Scanning.

- `success: true`

  Whether the API call was successful.

  - `true`

### Example

```http
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/settings \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "value": "enabled"
        }'
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "modified": "2024-12-02T09:57:23.150259Z",
    "value": "enabled"
  },
  "success": true
}
```

## Update Content Scanning Status

**put** `/zones/{zone_id}/content-upload-scan/settings`

Update the Content Scanning status.

### Path Parameters

- `zone_id: string`

  Defines an identifier.

### Body Parameters

- `value: "enabled" or "disabled"`

  The status value for Content Scanning.

  - `"enabled"`

  - `"disabled"`

### Returns

- `errors: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

    - `pointer: optional string`

- `messages: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

- `result:  { modified, value }`

  Defines the status for Content Scanning.

  - `modified: optional string`

    Defines the last modification date (ISO 8601) of the Content Scanning status.

  - `value: optional string`

    Defines the status of Content Scanning.

- `success: true`

  Whether the API call was successful.

  - `true`

### Example

```http
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/settings \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "value": "enabled"
        }'
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "modified": "2024-12-02T09:57:23.150259Z",
    "value": "enabled"
  },
  "success": true
}
```

## Get Content Scanning Status

**get** `/zones/{zone_id}/content-upload-scan/settings`

Retrieve the current status of Content Scanning.

### Path Parameters

- `zone_id: string`

  Defines an identifier.

### Returns

- `errors: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

    - `pointer: optional string`

- `messages: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

- `result:  { modified, value }`

  Defines the status for Content Scanning.

  - `modified: optional string`

    Defines the last modification date (ISO 8601) of the Content Scanning status.

  - `value: optional string`

    Defines the status of Content Scanning.

- `success: true`

  Whether the API call was successful.

  - `true`

### Example

```http
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/settings \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "modified": "2024-12-02T09:57:23.150259Z",
    "value": "enabled"
  },
  "success": true
}
```

## Domain Types

### Content Scanning Enable Response

- `ContentScanningEnableResponse = unknown`

### Content Scanning Disable Response

- `ContentScanningDisableResponse = unknown`

### Content Scanning Create Response

- `ContentScanningCreateResponse  { modified, value }`

  Defines the status for Content Scanning.

  - `modified: optional string`

    Defines the last modification date (ISO 8601) of the Content Scanning status.

  - `value: optional string`

    Defines the status of Content Scanning.

### Content Scanning Update Response

- `ContentScanningUpdateResponse  { modified, value }`

  Defines the status for Content Scanning.

  - `modified: optional string`

    Defines the last modification date (ISO 8601) of the Content Scanning status.

  - `value: optional string`

    Defines the status of Content Scanning.

### Content Scanning Get Response

- `ContentScanningGetResponse  { modified, value }`

  Defines the status for Content Scanning.

  - `modified: optional string`

    Defines the last modification date (ISO 8601) of the Content Scanning status.

  - `value: optional string`

    Defines the status of Content Scanning.

# Payloads

## List Existing Custom Scan Expressions

**get** `/zones/{zone_id}/content-upload-scan/payloads`

Get a list of existing custom scan expressions for Content Scanning.

### Path Parameters

- `zone_id: string`

  Defines an identifier.

### Returns

- `errors: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

    - `pointer: optional string`

- `messages: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

- `result: array of  { id, payload }`

  - `id: optional string`

    defines the unique ID for this custom scan expression.

  - `payload: optional string`

    Defines the ruleset expression to use in matching content objects.

- `success: true`

  Whether the API call was successful.

  - `true`

### Example

```http
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/payloads \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "a350a054caa840c9becd89c3b4f0195b",
      "payload": "lookup_json_string(http.request.body.raw, \"file\")"
    }
  ],
  "success": true
}
```

## Add Custom Scan Expressions

**post** `/zones/{zone_id}/content-upload-scan/payloads`

Add custom scan expressions for Content Scanning.

### Path Parameters

- `zone_id: string`

  Defines an identifier.

### Body Parameters

- `body: array of  { payload }`

  - `payload: string`

    Defines the ruleset expression to use in matching content objects.

### Returns

- `errors: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

    - `pointer: optional string`

- `messages: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

- `result: array of  { id, payload }`

  - `id: optional string`

    defines the unique ID for this custom scan expression.

  - `payload: optional string`

    Defines the ruleset expression to use in matching content objects.

- `success: true`

  Whether the API call was successful.

  - `true`

### Example

```http
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/payloads \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '[
          {
            "payload": "lookup_json_string(http.request.body.raw, \\"file\\")"
          }
        ]'
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "a350a054caa840c9becd89c3b4f0195b",
      "payload": "lookup_json_string(http.request.body.raw, \"file\")"
    }
  ],
  "success": true
}
```

## Delete a Custom Scan Expression

**delete** `/zones/{zone_id}/content-upload-scan/payloads/{expression_id}`

Delete a Content Scan Custom Expression.

### Path Parameters

- `zone_id: string`

  Defines an identifier.

- `expression_id: string`

  defines the unique ID for this custom scan expression.

### Returns

- `errors: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

    - `pointer: optional string`

- `messages: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

- `result: array of  { id, payload }`

  - `id: optional string`

    defines the unique ID for this custom scan expression.

  - `payload: optional string`

    Defines the ruleset expression to use in matching content objects.

- `success: true`

  Whether the API call was successful.

  - `true`

### Example

```http
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/payloads/$EXPRESSION_ID \
    -X DELETE \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "a350a054caa840c9becd89c3b4f0195b",
      "payload": "lookup_json_string(http.request.body.raw, \"file\")"
    }
  ],
  "success": true
}
```

## Domain Types

### Payload List Response

- `PayloadListResponse  { id, payload }`

  Defines a custom scan expression to match Content Scanning on.

  - `id: optional string`

    defines the unique ID for this custom scan expression.

  - `payload: optional string`

    Defines the ruleset expression to use in matching content objects.

### Payload Create Response

- `PayloadCreateResponse  { id, payload }`

  Defines a custom scan expression to match Content Scanning on.

  - `id: optional string`

    defines the unique ID for this custom scan expression.

  - `payload: optional string`

    Defines the ruleset expression to use in matching content objects.

### Payload Delete Response

- `PayloadDeleteResponse  { id, payload }`

  Defines a custom scan expression to match Content Scanning on.

  - `id: optional string`

    defines the unique ID for this custom scan expression.

  - `payload: optional string`

    Defines the ruleset expression to use in matching content objects.

# Settings

## Get Content Scanning Status

**get** `/zones/{zone_id}/content-upload-scan/settings`

Retrieve the current status of Content Scanning.

### Path Parameters

- `zone_id: string`

  Defines an identifier.

### Returns

- `errors: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

    - `pointer: optional string`

- `messages: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

- `result:  { modified, value }`

  Defines the status for Content Scanning.

  - `modified: optional string`

    Defines the last modification date (ISO 8601) of the Content Scanning status.

  - `value: optional string`

    Defines the status of Content Scanning.

- `success: true`

  Whether the API call was successful.

  - `true`

### Example

```http
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/content-upload-scan/settings \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "modified": "2024-12-02T09:57:23.150259Z",
    "value": "enabled"
  },
  "success": true
}
```

## Domain Types

### Setting Get Response

- `SettingGetResponse  { modified, value }`

  Defines the status for Content Scanning.

  - `modified: optional string`

    Defines the last modification date (ISO 8601) of the Content Scanning status.

  - `value: optional string`

    Defines the status of Content Scanning.