Skip to content
Cloudflare API
Start here
API Reference

Content Scanning

Enable Content Scanning
content_scanning.enable(ContentScanningEnableParams**kwargs) -> object
POST/zones/{zone_id}/content-upload-scan/enable
Disable Content Scanning
content_scanning.disable(ContentScanningDisableParams**kwargs) -> object
POST/zones/{zone_id}/content-upload-scan/disable

Content ScanningPayloads

List Existing Custom Scan Expressions
content_scanning.payloads.list(PayloadListParams**kwargs) -> SyncSinglePage[PayloadListResponse]
GET/zones/{zone_id}/content-upload-scan/payloads
Add Custom Scan Expressions
content_scanning.payloads.create(PayloadCreateParams**kwargs) -> SyncSinglePage[PayloadCreateResponse]
POST/zones/{zone_id}/content-upload-scan/payloads
Delete a Custom Scan Expression
content_scanning.payloads.delete(strexpression_id, PayloadDeleteParams**kwargs) -> SyncSinglePage[PayloadDeleteResponse]
DELETE/zones/{zone_id}/content-upload-scan/payloads/{expression_id}
ModelsExpand Collapse
class PayloadListResponse: …

Defines a custom scan expression to match Content Scanning on.

id: Optional[str]

defines the unique ID for this custom scan expression.

maxLength32
payload: Optional[str]

Defines the ruleset expression to use in matching content objects.

class PayloadCreateResponse: …

Defines a custom scan expression to match Content Scanning on.

id: Optional[str]

defines the unique ID for this custom scan expression.

maxLength32
payload: Optional[str]

Defines the ruleset expression to use in matching content objects.

class PayloadDeleteResponse: …

Defines a custom scan expression to match Content Scanning on.

id: Optional[str]

defines the unique ID for this custom scan expression.

maxLength32
payload: Optional[str]

Defines the ruleset expression to use in matching content objects.

Content ScanningSettings

Get Content Scanning Status
content_scanning.settings.get(SettingGetParams**kwargs) -> SettingGetResponse
GET/zones/{zone_id}/content-upload-scan/settings
ModelsExpand Collapse
class SettingGetResponse: …

Defines the status for Content Scanning.

modified: Optional[str]

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

value: Optional[str]

Defines the status of Content Scanning.