Get a Page Shield cookie

client.PageShield.Cookies.Get(ctx, cookieID, query) (*CookieGetResponse, error)

GET/zones/{zone_id}/page_shield/cookies/{cookie_id}

Fetches a cookie collected by Page Shield by cookie ID.

Security

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 ShieldDomain Page Shield ReadDomain Page ShieldPage Shield ReadZone Settings WriteZone Settings Read

ParametersExpand Collapse

cookieID string

Identifier

maxLength32

query CookieGetParams

ZoneID param.Field[string]

Identifier

maxLength32

ReturnsExpand Collapse

type CookieGetResponse struct{…}

ID string

Identifier

maxLength32

FirstSeenAt Time

formatdate-time

Host string

LastSeenAt Time

formatdate-time

Name string

Type CookieGetResponseType

One of the following:

const CookieGetResponseTypeFirstParty CookieGetResponseType = "first_party"

const CookieGetResponseTypeUnknown CookieGetResponseType = "unknown"

DomainAttribute stringoptional

ExpiresAttribute Timeoptional

formatdate-time

HTTPOnlyAttribute booloptional

MaxAgeAttribute int64optional

PageURLs []stringoptional

PathAttribute stringoptional

SameSiteAttribute CookieGetResponseSameSiteAttributeoptional

One of the following:

const CookieGetResponseSameSiteAttributeLax CookieGetResponseSameSiteAttribute = "lax"

const CookieGetResponseSameSiteAttributeStrict CookieGetResponseSameSiteAttribute = "strict"

const CookieGetResponseSameSiteAttributeNone CookieGetResponseSameSiteAttribute = "none"

SecureAttribute booloptional

Get a Page Shield cookie

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.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  cookie, err := client.PageShield.Cookies.Get(
    context.TODO(),
    "023e105f4ecef8ad9ca31a8372d0c353",
    page_shield.CookieGetParams{
      ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", cookie.ID)
}

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

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