Cloudflare API | Page Shield › Get Page Shield Settings

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/page_shield \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "success": true,
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": {
    "enabled": true,
    "updated_at": "2022-10-12T17:56:52.083582+01:00",
    "use_cloudflare_reporting_endpoint": true,
    "use_connection_url_path": true
  }
}

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... }

Page Shield

Connections

page_shield.connections

Methods

Get A Page Shield Connection -> Envelope<

Connection

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

Fetches a connection detected by Page Shield by connection ID.

List Page Shield Connections -> SinglePage<

Connection

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... }

Page Shield

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.

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.

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... }

Page Shield

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<

Script

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... }