API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Content Scanning

Enable Content Scanning for a zone.

content_scanning.enable(ContentScanningEnableParams**kwargs) -> object

POST/zones/{zone_id}/content-upload-scan/enable

Disable Content Scanning for a zone.

content_scanning.disable(ContentScanningDisableParams**kwargs) -> object

POST/zones/{zone_id}/content-upload-scan/disable

Update the Content Scanning status for a zone.

content_scanning.create(ContentScanningCreateParams**kwargs) -> ContentScanningCreateResponse

PUT/zones/{zone_id}/content-upload-scan/settings

Update the Content Scanning status for a zone.

content_scanning.update(ContentScanningUpdateParams**kwargs) -> ContentScanningUpdateResponse

PUT/zones/{zone_id}/content-upload-scan/settings

Get the Content Scanning status for a zone.

content_scanning.get(ContentScanningGetParams**kwargs) -> ContentScanningGetResponse

GET/zones/{zone_id}/content-upload-scan/settings

ModelsExpand Collapse

class ContentScanningCreateResponse: …

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.

class ContentScanningUpdateResponse: …

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.

class ContentScanningGetResponse: …

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.

Content ScanningPayloads

List the Content Scanning custom expressions of a zone.

content_scanning.payloads.list(PayloadListParams**kwargs) -> SyncSinglePage[PayloadListResponse]

GET/zones/{zone_id}/content-upload-scan/payloads

Create Content Scanning custom expressions for a zone.

content_scanning.payloads.create(PayloadCreateParams**kwargs) -> SyncSinglePage[PayloadCreateResponse]

POST/zones/{zone_id}/content-upload-scan/payloads

Delete a Content Scanning custom expression from a zone.

content_scanning.payloads.delete(strexpression_id, PayloadDeleteParams**kwargs) -> SyncSinglePage[PayloadDeleteResponse]

DELETE/zones/{zone_id}/content-upload-scan/payloads/{expression_id}

Update a Content Scanning custom expression for a zone.

content_scanning.payloads.update(strexpression_id, PayloadUpdateParams**kwargs) -> SyncSinglePage[PayloadUpdateResponse]

PATCH/zones/{zone_id}/content-upload-scan/payloads/{expression_id}

ModelsExpand Collapse

class PayloadListResponse: …

Defines a Content Scanning custom expression.

id: Optional[str]

Defines the unique ID for this Content Scanning custom expression.

maxLength32

payload: Optional[str]

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

class PayloadCreateResponse: …

Defines a Content Scanning custom expression.

id: Optional[str]

Defines the unique ID for this Content Scanning custom expression.

maxLength32

payload: Optional[str]

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

class PayloadDeleteResponse: …

Defines a Content Scanning custom expression.

id: Optional[str]

Defines the unique ID for this Content Scanning custom expression.

maxLength32

payload: Optional[str]

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

class PayloadUpdateResponse: …

Defines a Content Scanning custom expression.

id: Optional[str]

Defines the unique ID for this Content Scanning custom expression.

maxLength32

payload: Optional[str]

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

Content ScanningSettings

Get the Content Scanning status for a zone.

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.