Cloudflare API | Page Shield › Policies › Create A Page Shield Policy

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Network Monitoring

Observability

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Durable Objects

Workers For Platforms

Shared

Page Shield

page_shield

Methods

Get Page Shield Settings -> Envelope<

>

get/zones/{zone_id}/page_shield

Fetches the Page Shield settings.

Update Page Shield Settings -> Envelope<{ enabled, updated_at, use_cloudflare_reporting_endpoint, 1 more... }>

put/zones/{zone_id}/page_shield

Updates Page Shield settings.

Domain types

Setting = { enabled, updated_at, use_cloudflare_reporting_endpoint, 1 more... }

Connections

page_shield.connections

Methods

Get A Page Shield Connection -> Envelope<

>

get/zones/{zone_id}/page_shield/connections/{connection_id}

Fetches a connection detected by Page Shield by connection ID.

List Page Shield Connections -> SinglePage<

>

get/zones/{zone_id}/page_shield/connections

Lists all connections detected by Page Shield.

Domain types

Connection = { id, added_at, first_seen_at, 10 more... }

Cookies

page_shield.cookies

Methods

Get A Page Shield Cookie -> Envelope<{ id, first_seen_at, host, 11 more... }>

get/zones/{zone_id}/page_shield/cookies/{cookie_id}

Fetches a cookie collected by Page Shield by cookie ID.

List Page Shield Cookies -> SinglePage<{ id, first_seen_at, host, 11 more... }>

get/zones/{zone_id}/page_shield/cookies

Lists all cookies collected by Page Shield.

Policies

page_shield.policies

Methods

Create A Page Shield Policy -> Envelope<{ id, action, description, 3 more... }>

post/zones/{zone_id}/page_shield/policies

Create a Page Shield policy.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example: X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example: X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Page Shield Domain Page Shield Zone Settings Write

Parameters

zone_id: string

(maxLength: 32)

Identifier

Response fields

result: { id, action, description, 3 more... }

success: true

Whether the API call was successful

errors: Array<

>

Optional

messages: Array<

>

Optional

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/page_shield/policies \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d "{
      \"action\": \"allow\",
      \"description\": \"Checkout page CSP policy\",
      \"enabled\": true,
      \"expression\": \"ends_with(http.request.uri.path, \\\"/checkout\\\")\",
      \"value\": \"script-src 'none';\"
    }"

200Example

{
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "action": "allow",
    "description": "Checkout page CSP policy",
    "enabled": true,
    "expression": "ends_with(http.request.uri.path, \"/checkout\")",
    "value": "script-src 'none';"
  },
  "success": true,
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ]
}

Delete A Page Shield Policy ->

delete/zones/{zone_id}/page_shield/policies/{policy_id}

Delete a Page Shield policy by ID.

Get A Page Shield Policy -> Envelope<{ id, action, description, 3 more... }>

get/zones/{zone_id}/page_shield/policies/{policy_id}

Fetches a Page Shield policy by ID.

List Page Shield Policies -> SinglePage<{ id, action, description, 3 more... }>

get/zones/{zone_id}/page_shield/policies

Lists all Page Shield policies.

Update A Page Shield Policy -> Envelope<{ id, action, description, 3 more... }>

put/zones/{zone_id}/page_shield/policies/{policy_id}

Update a Page Shield policy by ID.

Domain types

Policy = { action, description, enabled, 2 more... }

Scripts

page_shield.scripts

Methods

Get A Page Shield Script -> Envelope<{ id, added_at, first_seen_at, 19 more... }>

get/zones/{zone_id}/page_shield/scripts/{script_id}

Fetches a script detected by Page Shield by script ID.

List Page Shield Scripts -> SinglePage<

>

get/zones/{zone_id}/page_shield/scripts

Lists all scripts detected by Page Shield.

Domain types

Script = { id, added_at, first_seen_at, 18 more... }