Skip to content
Cloudflare API
Start here
API Reference
Page Shield

Cookies

data cloudflare_page_shield_cookies

required Expand Collapse
cookie_id: String

Identifier

zone_id: String

Identifier

computed Expand Collapse
domain_attribute: String
expires_attribute: Time
first_seen_at: Time
host: String
http_only_attribute: Bool
id: String

Identifier

last_seen_at: Time
max_age_attribute: Int64
name: String
path_attribute: String
same_site_attribute: String
secure_attribute: Bool
type: String
page_urls: List[String]

cloudflare_page_shield_cookies

data "cloudflare_page_shield_cookies" "example_page_shield_cookies" {
  zone_id = "023e105f4ecef8ad9ca31a8372d0c353"
  cookie_id = "023e105f4ecef8ad9ca31a8372d0c353"
}

data cloudflare_page_shield_cookies_list

required Expand Collapse
zone_id: String

Identifier

optional Expand Collapse
direction?: String

The direction used to sort returned cookies.'

domain?: String

Filters the returned cookies that match the specified domain attribute

export?: String

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

hosts?: String

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?: Bool

Filters the returned cookies that are set with HttpOnly

name?: String

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?: String

The field used to sort returned cookies.

page?: String

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?: String

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?: String

Filters the returned cookies that match the specified path attribute

per_page?: Float64

The number of results per page.

same_site?: String

Filters the returned cookies that match the specified same_site attribute

secure?: Bool

Filters the returned cookies that are set with Secure

type?: String

Filters the returned cookies that match the specified type attribute

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse
result: List[Attributes]

The items returned by the data source

id: String

Identifier

first_seen_at: Time
host: String
last_seen_at: Time
name: String
type: String
domain_attribute: String
expires_attribute: Time
http_only_attribute: Bool
max_age_attribute: Int64
page_urls: List[String]
path_attribute: String
same_site_attribute: String
secure_attribute: Bool

cloudflare_page_shield_cookies_list

data "cloudflare_page_shield_cookies_list" "example_page_shield_cookies_list" {
  zone_id = "023e105f4ecef8ad9ca31a8372d0c353"
  direction = "asc"
  domain = "example.com"
  export = "csv"
  hosts = "blog.cloudflare.com,www.example*,*cloudflare.com"
  http_only = true
  name = "session_id"
  order_by = "first_seen_at"
  page = "2"
  page_url = "example.com/page,*/checkout,example.com/*,*checkout*"
  path = "/"
  per_page = 100
  same_site = "strict"
  secure = true
  type = "first_party"
}