Skip to content
Cloudflare API
Start here
API Reference

Content Scanning

Enable Content Scanning for a zone.
client.contentScanning.enable(ContentScanningEnableParams { zone_id } params, RequestOptionsoptions?): ContentScanningEnableResponse
POST/zones/{zone_id}/content-upload-scan/enable
Disable Content Scanning for a zone.
client.contentScanning.disable(ContentScanningDisableParams { zone_id } params, RequestOptionsoptions?): ContentScanningDisableResponse
POST/zones/{zone_id}/content-upload-scan/disable
Update the Content Scanning status for a zone.
client.contentScanning.create(ContentScanningCreateParams { zone_id, value } params, RequestOptionsoptions?): ContentScanningCreateResponse { modified, value }
PUT/zones/{zone_id}/content-upload-scan/settings
Update the Content Scanning status for a zone.
client.contentScanning.update(ContentScanningUpdateParams { zone_id, value } params, RequestOptionsoptions?): ContentScanningUpdateResponse { modified, value }
PUT/zones/{zone_id}/content-upload-scan/settings
Get the Content Scanning status for a zone.
client.contentScanning.get(ContentScanningGetParams { zone_id } params, RequestOptionsoptions?): ContentScanningGetResponse { modified, value }
GET/zones/{zone_id}/content-upload-scan/settings
ModelsExpand Collapse
ContentScanningEnableResponse = unknown
ContentScanningDisableResponse = unknown
ContentScanningCreateResponse { modified, value }

Defines the status for Content Scanning.

modified?: string

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

value?: string

Defines the status of Content Scanning.

ContentScanningUpdateResponse { modified, value }

Defines the status for Content Scanning.

modified?: string

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

value?: string

Defines the status of Content Scanning.

ContentScanningGetResponse { modified, value }

Defines the status for Content Scanning.

modified?: string

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

value?: string

Defines the status of Content Scanning.

Content ScanningPayloads

List the Content Scanning custom expressions of a zone.
client.contentScanning.payloads.list(PayloadListParams { zone_id } params, RequestOptionsoptions?): SinglePage<PayloadListResponse { id, payload } >
GET/zones/{zone_id}/content-upload-scan/payloads
Create Content Scanning custom expressions for a zone.
client.contentScanning.payloads.create(PayloadCreateParams { zone_id, body } params, RequestOptionsoptions?): SinglePage<PayloadCreateResponse { id, payload } >
POST/zones/{zone_id}/content-upload-scan/payloads
Delete a Content Scanning custom expression from a zone.
client.contentScanning.payloads.delete(stringexpressionID, PayloadDeleteParams { zone_id } params, RequestOptionsoptions?): SinglePage<PayloadDeleteResponse { id, payload } >
DELETE/zones/{zone_id}/content-upload-scan/payloads/{expression_id}
Update a Content Scanning custom expression for a zone.
client.contentScanning.payloads.update(stringexpressionID, PayloadUpdateParams { zone_id, payload } params, RequestOptionsoptions?): SinglePage<PayloadUpdateResponse { id, payload } >
PATCH/zones/{zone_id}/content-upload-scan/payloads/{expression_id}
ModelsExpand Collapse
PayloadListResponse { id, payload }

Defines a Content Scanning custom expression.

id?: string

Defines the unique ID for this Content Scanning custom expression.

maxLength32
payload?: string

Defines the custom content extraction expression used to reach content objects in the request.

PayloadCreateResponse { id, payload }

Defines a Content Scanning custom expression.

id?: string

Defines the unique ID for this Content Scanning custom expression.

maxLength32
payload?: string

Defines the custom content extraction expression used to reach content objects in the request.

PayloadDeleteResponse { id, payload }

Defines a Content Scanning custom expression.

id?: string

Defines the unique ID for this Content Scanning custom expression.

maxLength32
payload?: string

Defines the custom content extraction expression used to reach content objects in the request.

PayloadUpdateResponse { id, payload }

Defines a Content Scanning custom expression.

id?: string

Defines the unique ID for this Content Scanning custom expression.

maxLength32
payload?: string

Defines the custom content extraction expression used to reach content objects in the request.

Content ScanningSettings

Get the Content Scanning status for a zone.
client.contentScanning.settings.get(SettingGetParams { zone_id } params, RequestOptionsoptions?): SettingGetResponse { modified, value }
GET/zones/{zone_id}/content-upload-scan/settings
ModelsExpand Collapse
SettingGetResponse { modified, value }

Defines the status for Content Scanning.

modified?: string

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

value?: string

Defines the status of Content Scanning.