--- title: List detected cookies --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Page Shield](https://developers.cloudflare.com/api/go/resources/page_shield) [Cookies](https://developers.cloudflare.com/api/go/resources/page_shield/subresources/cookies) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List detected cookies client.PageShield.Cookies.List(ctx, params) (\*SinglePage\[[CookieListResponse]()], error) 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
params CookieListParams ZoneID param.Field\[string] Path param: Identifier maxLength32 Link to this property
Direction param.Field\[CookieListParamsDirection]Optional Query param: The direction used to sort returned cookies.’ const CookieListParamsDirectionAsc CookieListParamsDirection = "asc" Link to this property const CookieListParamsDirectionDesc CookieListParamsDirection = "desc" Link to this property
Link to this property Domain param.Field\[string]Optional Query param: Filters the returned cookies that match the specified domain attribute maxLength1024 Link to this property
Export param.Field\[CookieListParamsExport]Optional Query param: Export the list of cookies as a file, limited to 50000 entries. const CookieListParamsExportCsv CookieListParamsExport = "csv" Link to this property
Link to this property Hosts param.Field\[string]Optional Query param: 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 HTTPOnly param.Field\[bool]Optional Query param: Filters the returned cookies that are set with HttpOnly Link to this property Name param.Field\[string]Optional Query param: 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
OrderBy param.Field\[CookieListParamsOrderBy]Optional Query param: The field used to sort returned cookies. const CookieListParamsOrderByFirstSeenAt CookieListParamsOrderBy = "first\_seen\_at" Link to this property const CookieListParamsOrderByLastSeenAt CookieListParamsOrderBy = "last\_seen\_at" Link to this property
Link to this property Page param.Field\[string]Optional Query param: 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 PageURL param.Field\[string]Optional Query param: 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 Path param.Field\[string]Optional Query param: Filters the returned cookies that match the specified path attribute maxLength1024 Link to this property PerPage param.Field\[float64]Optional Query param: The number of results per page. maximum100 minimum1 Link to this property
SameSite param.Field\[CookieListParamsSameSite]Optional Query param: Filters the returned cookies that match the specified same\_site attribute const CookieListParamsSameSiteLax CookieListParamsSameSite = "lax" Link to this property const CookieListParamsSameSiteStrict CookieListParamsSameSite = "strict" Link to this property const CookieListParamsSameSiteNone CookieListParamsSameSite = "none" Link to this property
Link to this property Secure param.Field\[bool]Optional Query param: Filters the returned cookies that are set with Secure Link to this property
Type param.Field\[CookieListParamsType]Optional Query param: Filters the returned cookies that match the specified type attribute const CookieListParamsTypeFirstParty CookieListParamsType = "first\_party" Link to this property const CookieListParamsTypeUnknown CookieListParamsType = "unknown" Link to this property
Link to this property
[Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type CookieListResponse struct{…} ID string Identifier maxLength32 Link to this property FirstSeenAt Time formatdate-time Link to this property Host string Link to this property LastSeenAt Time formatdate-time Link to this property Name string Link to this property
Type CookieListResponseType One of the following: const CookieListResponseTypeFirstParty CookieListResponseType = "first\_party" Link to this property const CookieListResponseTypeUnknown CookieListResponseType = "unknown" Link to this property
Link to this property DomainAttribute stringOptional Link to this property ExpiresAttribute TimeOptional formatdate-time Link to this property HTTPOnlyAttribute boolOptional Link to this property MaxAgeAttribute int64Optional Link to this property PageURLs \[]stringOptional Link to this property PathAttribute stringOptional Link to this property
SameSiteAttribute CookieListResponseSameSiteAttributeOptional One of the following: const CookieListResponseSameSiteAttributeLax CookieListResponseSameSiteAttribute = "lax" Link to this property const CookieListResponseSameSiteAttributeStrict CookieListResponseSameSiteAttribute = "strict" Link to this property const CookieListResponseSameSiteAttributeNone CookieListResponseSameSiteAttribute = "none" Link to this property
Link to this property SecureAttribute boolOptional Link to this property
[Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(model)%20CookieListResponse%20%3E%20(schema)>) ### List detected cookies Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/page_shield" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) page, err := client.PageShield.Cookies.List(context.TODO(), page_shield.CookieListParams{ ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` 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" } } ] } ```