Cloudflare API | Content Scanning › Get Content Scanning Status

API Reference

Overview

Account & User Management

Abuse Reports

Certificate Management

ACM

Certificate Authorities

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

SSL

Cloudflare One

Email Security

Zero Trust

DNS

Account Custom Nameservers

DNS

DNS Firewall

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Magic Transit

Network Interconnects

Observability

Radar

Routing & Performance

Rules

Storage & Databases

Threat Intelligence

Workers & Pages

Workers For Platforms

Shared

Content Scanning

content_scanning

Methods

Enable Content Scanning -> Envelope<unknown>

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

Enable Content Scanning.

Disable Content Scanning -> Envelope<unknown>

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

Disable Content Scanning.

Update Content Scanning Status -> Envelope<{ modified, value }>

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

Update the Content Scanning status.

Update Content Scanning Status -> Envelope<{ modified, value }>

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

Update the Content Scanning status.

Get Content Scanning Status -> Envelope<{ modified, value }>

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

Retrieve the current status of Content Scanning.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Zone WAF Write Zone WAF Read Account WAF Write Account WAF Read

path Parameters

zone_id: string

(maxLength: 32)

Defines an identifier.

Response fields

errors: Array<

ResponseInfo

messages: Array<

ResponseInfo

result: { modified, value }

Defines the status for Content Scanning.

success: true

Whether the API call was successful.

Request example

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

200Example

{
  "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
}

Content Scanning

Payloads

content_scanning.payloads

Methods

List Existing Custom Scan Expressions -> SinglePage<{ id, payload }>

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

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

Add Custom Scan Expressions -> SinglePage<{ id, payload }>

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

Add custom scan expressions for Content Scanning.

Delete A Custom Scan Expression -> SinglePage<{ id, payload }>

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

Delete a Content Scan Custom Expression.

Content Scanning

Settings

content_scanning.settings

Methods

Get Content Scanning Status -> Envelope<{ modified, value }>

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

Retrieve the current status of Content Scanning.