---
title: Get a detected cookie
---

[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**

# Get a detected cookie

page\_shield.cookies.get(strcookie\_id, CookieGetParams\*\*kwargs) -> [CookieGetResponse](<https://developers.cloudflare.com/api/python/resources/page_shield#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)>)

GET/zones/{zone\_id}/page\_shield/cookies/{cookie\_id}

Returns a cookie detected on the zone by cookie ID.

##### Security

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**<code>X-Auth-Email: user@example.com</code>

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### 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)%20get%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)

cookie\_id: str

Identifier

maxLength32

[Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20cookie_id%20%3E%20(schema)>)

##### ReturnsExpand Collapse

<details>

<summary>

class CookieGetResponse: …

</summary>

id: str

Identifier

maxLength32

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

first\_seen\_at: datetime

formatdate-time

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20first_seen_at">Link to this property</a>

host: str

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20host">Link to this property</a>

last\_seen\_at: datetime

formatdate-time

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20last_seen_at">Link to this property</a>

name: str

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20name">Link to this property</a>

<details>

<summary>

type: Literal\["first\_party", "unknown"]

</summary>

One of the following:

"first\_party"

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20type%20%3E%20(member)%200">Link to this property</a>

"unknown"

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20type%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20type">Link to this property</a>

domain\_attribute: Optional\[str]

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20domain_attribute">Link to this property</a>

expires\_attribute: Optional\[datetime]

formatdate-time

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20expires_attribute">Link to this property</a>

http\_only\_attribute: Optional\[bool]

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20http_only_attribute">Link to this property</a>

max\_age\_attribute: Optional\[int]

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20max_age_attribute">Link to this property</a>

page\_urls: Optional\[List\[str]]

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20page_urls">Link to this property</a>

path\_attribute: Optional\[str]

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20path_attribute">Link to this property</a>

<details>

<summary>

same\_site\_attribute: Optional\[Literal\["lax", "strict", "none"]]

</summary>

One of the following:

"lax"

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20same_site_attribute%20%3E%20(member)%200">Link to this property</a>

"strict"

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20same_site_attribute%20%3E%20(member)%201">Link to this property</a>

"none"

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20same_site_attribute%20%3E%20(member)%202">Link to this property</a>

</details>

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20same_site_attribute">Link to this property</a>

secure\_attribute: Optional\[bool]

<a href="#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)%20%3E%20(property)%20secure_attribute">Link to this property</a>

</details>

[Link to this property](<#(resource)%20page_shield.cookies%20%3E%20(model)%20cookie_get_response%20%3E%20(schema)>)

### Get a detected cookie

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
)
cookie = client.page_shield.cookies.get(
    cookie_id="023e105f4ecef8ad9ca31a8372d0c353",
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(cookie.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
  },
  "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
  },
  "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"
      }
    }
  ]
}
```