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

### Parameters

- `zone_id: str`

  Identifier

- `direction: Optional[Literal["asc", "desc"]]`

  The direction used to sort returned cookies.'

  - `"asc"`

  - `"desc"`

- `domain: Optional[str]`

  Filters the returned cookies that match the specified domain attribute

- `export: Optional[Literal["csv"]]`

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

  - `"csv"`

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

- `order_by: Optional[Literal["first_seen_at", "last_seen_at"]]`

  The field used to sort returned cookies.

  - `"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

- `per_page: Optional[float]`

  The number of results per page.

- `same_site: Optional[Literal["lax", "strict", "none"]]`

  Filters the returned cookies that match the specified same_site attribute

  - `"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

  - `"first_party"`

  - `"unknown"`

### Returns

- `class CookieListResponse: …`

  - `id: str`

    Identifier

  - `first_seen_at: datetime`

  - `host: str`

  - `last_seen_at: datetime`

  - `name: str`

  - `type: Literal["first_party", "unknown"]`

    - `"first_party"`

    - `"unknown"`

  - `domain_attribute: Optional[str]`

  - `expires_attribute: Optional[datetime]`

  - `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"]]`

    - `"lax"`

    - `"strict"`

    - `"none"`

  - `secure_attribute: Optional[bool]`

### Example

```python
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)
```

#### Response

```json
{
  "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"
      }
    }
  ]
}
```

## Get a Page Shield cookie

`page_shield.cookies.get(strcookie_id, CookieGetParams**kwargs)  -> CookieGetResponse`

**get** `/zones/{zone_id}/page_shield/cookies/{cookie_id}`

Fetches a cookie collected by Page Shield by cookie ID.

### Parameters

- `zone_id: str`

  Identifier

- `cookie_id: str`

  Identifier

### Returns

- `class CookieGetResponse: …`

  - `id: str`

    Identifier

  - `first_seen_at: datetime`

  - `host: str`

  - `last_seen_at: datetime`

  - `name: str`

  - `type: Literal["first_party", "unknown"]`

    - `"first_party"`

    - `"unknown"`

  - `domain_attribute: Optional[str]`

  - `expires_attribute: Optional[datetime]`

  - `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"]]`

    - `"lax"`

    - `"strict"`

    - `"none"`

  - `secure_attribute: Optional[bool]`

### Example

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

#### Response

```json
{
  "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"
      }
    }
  ]
}
```

## Domain Types

### Cookie List Response

- `class CookieListResponse: …`

  - `id: str`

    Identifier

  - `first_seen_at: datetime`

  - `host: str`

  - `last_seen_at: datetime`

  - `name: str`

  - `type: Literal["first_party", "unknown"]`

    - `"first_party"`

    - `"unknown"`

  - `domain_attribute: Optional[str]`

  - `expires_attribute: Optional[datetime]`

  - `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"]]`

    - `"lax"`

    - `"strict"`

    - `"none"`

  - `secure_attribute: Optional[bool]`

### Cookie Get Response

- `class CookieGetResponse: …`

  - `id: str`

    Identifier

  - `first_seen_at: datetime`

  - `host: str`

  - `last_seen_at: datetime`

  - `name: str`

  - `type: Literal["first_party", "unknown"]`

    - `"first_party"`

    - `"unknown"`

  - `domain_attribute: Optional[str]`

  - `expires_attribute: Optional[datetime]`

  - `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"]]`

    - `"lax"`

    - `"strict"`

    - `"none"`

  - `secure_attribute: Optional[bool]`