API Reference

Content Scanning

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Payloads

List Existing Custom Scan Expressions

client.contentScanning.payloads.list(PayloadListParams { zone_id } params, RequestOptionsoptions?): SinglePage<PayloadListResponse { id, payload } >

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

Add Custom Scan Expressions

client.contentScanning.payloads.create(PayloadCreateParams { zone_id, body } params, RequestOptionsoptions?): SinglePage<PayloadCreateResponse { id, payload } >

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

Delete a Custom Scan Expression

client.contentScanning.payloads.delete(stringexpressionId, PayloadDeleteParams { zone_id } params, RequestOptionsoptions?): SinglePage<PayloadDeleteResponse { id, payload } >

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

ModelsExpand Collapse

PayloadListResponse { id, payload }

Defines a custom scan expression to match Content Scanning on.

id?: string

defines the unique ID for this custom scan expression.

maxLength32

payload?: string

Defines the ruleset expression to use in matching content objects.

PayloadCreateResponse { id, payload }

Defines a custom scan expression to match Content Scanning on.

id?: string

defines the unique ID for this custom scan expression.

maxLength32

payload?: string

Defines the ruleset expression to use in matching content objects.

PayloadDeleteResponse { id, payload }

Defines a custom scan expression to match Content Scanning on.

id?: string

defines the unique ID for this custom scan expression.

maxLength32

payload?: string

Defines the ruleset expression to use in matching content objects.