Cloudflare API | Page Shield › Cookies › List Page Shield Cookies

Wildcards are supported at the start and end of each hostname to support starts with, ends with and contains. If no wildcards are used, results will be filtered by exact match

http_only: boolean

Optional

Filters the returned cookies that are set with HttpOnly

name: string

Optional

(maxLength: 1024)

Filters the returned cookies that match the specified name. Wildcards are supported at the start and end to support starts with, ends with and contains. e.g. session*

order_by:

Optional

The field used to sort returned cookies.

"first_seen_at"

"last_seen_at"

page: string

Optional

The current page number of the paginated results.

We additionally support a special value "all". When "all" is used, the API will return all the cookies with the applied filters in a single page. This feature is best-effort and it may only work for zones with a low number of cookies

page_url: string

Optional

Includes connections that match one or more page URLs (separated by commas) where they were last seen

Wildcards are supported at the start and end of each page URL to support starts with, ends with and contains. If no wildcards are used, results will be filtered by exact match

path: string

Optional

(maxLength: 1024)

Filters the returned cookies that match the specified path attribute

per_page: number

Optional

(maximum: 100, minimum: 1)

The number of results per page.

same_site:

Optional

Filters the returned cookies that match the specified same_site attribute

"lax"

"strict"

"none"

secure: boolean

Optional

Filters the returned cookies that are set with Secure

type:

Optional

Filters the returned cookies that match the specified type attribute

"first_party"

"unknown"

Response fields

result: Array<{ id, first_seen_at, host, 11 more... }>

result_info: { count, page, per_page, 2 more... }

success: true

Whether the API call was successful

errors: Array<

ResponseInfo

Optional

messages: Array<

ResponseInfo

Optional

Request example

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

200Example

{
  "result": [
    {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "first_seen_at": "2021-08-18T10:51:08Z",
      "host": "blog.cloudflare.com",
      "last_seen_at": "2021-09-02T09:57:54Z",
      "name": "session_id",
      "type": "first_party",
      "domain_attribute": "cloudflare.com",
      "expires_attribute": "2021-10-02T09:57:54Z",
      "http_only_attribute": true,
      "max_age_attribute": 3600,
      "page_urls": [
        "blog.cloudflare.com/page1",
        "blog.cloudflare.com/page2"
      ],
      "path_attribute": "/",
      "same_site_attribute": "lax",
      "secure_attribute": true
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  },
  "success": true,
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ]
}

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