• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Cookies

Settings API - Cookies schema table

Cookies (builtin:synthetic.http.cookies)

Set cookies to store state information or instruct the server not to send certain kinds of information.

Schema IDSchema groupsScope
builtin:synthetic.http.cookies
  • group:synthetic.http
HTTP_CHECK - HTTP monitor
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:synthetic.http.cookies
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:synthetic.http.cookies
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:synthetic.http.cookies

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyLabelTypeDescriptionRequired
enabledSet cookiesboolean-required
cookies-set-required

Request body objects

The CookieEntry object
PropertyLabelTypeDescriptionRequired
nameNametext

Enclose placeholder values in brackets, for example {email}

required
valueValuetext

Enclose placeholder values in brackets, for example {email}

required
domainDomaintext

Enclose placeholder values in brackets, for example {email}

required
pathPath (optional)text

Enclose placeholder values in brackets, for example {email}

optional