Skip to content
Cloudflare API
Start here
API Reference
Page Shield
Cookies

List Page Shield Cookies

page_shield.cookies.list(CookieListParams**kwargs) -> SyncSinglePage[CookieListResponse]
GET/zones/{zone_id}/page_shield/cookies

Lists all cookies collected by Page Shield.

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 ShieldDomain Page Shield ReadDomain Page ShieldPage Shield ReadZone Settings WriteZone Settings Read
ParametersExpand Collapse
zone_id: str

Identifier

maxLength32
direction: Optional[Literal["asc", "desc"]]

The direction used to sort returned cookies.'

One of the following:
"asc"
"desc"
domain: Optional[str]

Filters the returned cookies that match the specified domain attribute

maxLength1024
export: Optional[Literal["csv"]]

Export the list of cookies as a file, limited to 50000 entries.

hosts: Optional[str]

Includes cookies that match one or more URL-encoded hostnames separated by commas.

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: Optional[bool]

Filters the returned cookies that are set with HttpOnly

name: Optional[str]

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*

maxLength1024
order_by: Optional[Literal["first_seen_at", "last_seen_at"]]

The field used to sort returned cookies.

One of the following:
"first_seen_at"
"last_seen_at"
page: Optional[str]

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: Optional[str]

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: Optional[str]

Filters the returned cookies that match the specified path attribute

maxLength1024
per_page: Optional[float]

The number of results per page.

maximum100
minimum1
same_site: Optional[Literal["lax", "strict", "none"]]

Filters the returned cookies that match the specified same_site attribute

One of the following:
"lax"
"strict"
"none"
secure: Optional[bool]

Filters the returned cookies that are set with Secure

type: Optional[Literal["first_party", "unknown"]]

Filters the returned cookies that match the specified type attribute

One of the following:
"first_party"
"unknown"
ReturnsExpand Collapse
class CookieListResponse: …
id: str

Identifier

maxLength32
first_seen_at: datetime
formatdate-time
host: str
last_seen_at: datetime
formatdate-time
name: str
type: Literal["first_party", "unknown"]
One of the following:
"first_party"
"unknown"
domain_attribute: Optional[str]
expires_attribute: Optional[datetime]
formatdate-time
http_only_attribute: Optional[bool]
max_age_attribute: Optional[int]
page_urls: Optional[List[str]]
path_attribute: Optional[str]
same_site_attribute: Optional[Literal["lax", "strict", "none"]]
One of the following:
"lax"
"strict"
"none"
secure_attribute: Optional[bool]

List Page Shield Cookies

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
page = client.page_shield.cookies.list(
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.id)
{
  "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": "strict",
      "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",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ]
}
Returns Examples
{
  "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": "strict",
      "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",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ]
}