--- title: List detected cookies --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Page Shield](https://developers.cloudflare.com/api/python/resources/page_shield) [Cookies](https://developers.cloudflare.com/api/python/resources/page_shield/subresources/cookies) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List detected cookies page\_shield.cookies.list(CookieListParams\*\*kwargs) -> SyncSinglePage\[[CookieListResponse]()] GET/zones/{zone\_id}/page\_shield/cookies Lists cookies detected on the zone. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
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 Read``Domain Page Shield``Page Shield Read``Zone Settings Write``Zone Settings Read` ##### ParametersExpand Collapse zone\_id: str Identifier maxLength32 [Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)
direction: Optional\[Literal\["asc", "desc"]] The direction used to sort returned cookies.’ One of the following: "asc" Link to this property "desc" Link to this property
[Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20direction%20%3E%20(schema)>) domain: Optional\[str] Filters the returned cookies that match the specified domain attribute maxLength1024 [Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20domain%20%3E%20(schema)>) export: Optional\[Literal\["csv"]] Export the list of cookies as a file, limited to 50000 entries. [Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20export%20%3E%20(schema)>) 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 [Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20hosts%20%3E%20(schema)>) http\_only: Optional\[[bool]()] Filters the returned cookies that are set with HttpOnly [Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20http_only%20%3E%20(schema)>) 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 [Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20name%20%3E%20(schema)>)
order\_by: Optional\[Literal\["first\_seen\_at", "last\_seen\_at"]] The field used to sort returned cookies. One of the following: "first\_seen\_at" Link to this property "last\_seen\_at" Link to this property
[Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20order_by%20%3E%20(schema)>) 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 [Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20page%20%3E%20(schema)>) 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 [Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20page_url%20%3E%20(schema)>) path: Optional\[str] Filters the returned cookies that match the specified path attribute maxLength1024 [Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20path%20%3E%20(schema)>) per\_page: Optional\[float] The number of results per page. maximum100 minimum1 [Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20per_page%20%3E%20(schema)>)
same\_site: Optional\[Literal\["lax", "strict", "none"]] Filters the returned cookies that match the specified same\_site attribute One of the following: "lax" Link to this property "strict" Link to this property "none" Link to this property
[Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20same_site%20%3E%20(schema)>) secure: Optional\[[bool]()] Filters the returned cookies that are set with Secure [Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20secure%20%3E%20(schema)>)
type: Optional\[Literal\["first\_party", "unknown"]] Filters the returned cookies that match the specified type attribute One of the following: "first\_party" Link to this property "unknown" Link to this property
[Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20type%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class CookieListResponse: … id: str Identifier maxLength32 Link to this property first\_seen\_at: datetime formatdate-time Link to this property host: str Link to this property last\_seen\_at: datetime formatdate-time Link to this property name: str Link to this property
type: Literal\["first\_party", "unknown"] One of the following: "first\_party" Link to this property "unknown" Link to this property
Link to this property domain\_attribute: Optional\[str] Link to this property expires\_attribute: Optional\[datetime] formatdate-time Link to this property http\_only\_attribute: Optional\[bool] Link to this property max\_age\_attribute: Optional\[int] Link to this property page\_urls: Optional\[List\[str]] Link to this property path\_attribute: Optional\[str] Link to this property
same\_site\_attribute: Optional\[Literal\["lax", "strict", "none"]] One of the following: "lax" Link to this property "strict" Link to this property "none" Link to this property
Link to this property secure\_attribute: Optional\[bool] Link to this property
[Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_list_response%20%3E%20(schema)>) ### List detected cookies Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.page_shield.cookies.list( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) page = page.result[0] print(page.id) ``` 200 example ``` { "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 200 example ``` { "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" } } ] } ```