Sign in

v7

latestOpenAPI 3.0.4raw.githubusercontent.com2026-08-033267145.4 KB
Cookie

Adds a list of cookies to the profile, allowing you to inject cookies before starting the profile. If cookies already exist for a domain, they will be replaced with the new ones.

post/profiles/{guid}/cookies

Path parameters

guidstring uuid required

The unique identifier of the profile

Request body

domainstring required

The domain attribute signifies the domain for which the cookie is valid and can be submitted with every request for this domain or its subdomains. If this attribute is not specified, then the hostname of the originating server is used as the default value.

namestring required

The name for the Cookie.

pathstring required

The path attribute indicates a URL path that must exist in the requested URL in order to send the Cookie header. The %x2F ("/") character is considered a directory separator, and subdirectories match as well.

valuestring required

The value of the Cookie.

hostOnlyboolean

Host Only cookie means that the cookie should be handled by the browser to the server only to the same host/server that firstly sent it to the browser.

httpOnlyboolean

When this attribute is set, client-side scripts are not allowed to access the cookie.

secureboolean

A cookie with the Secure attribute is sent to the server only with an encrypted request over the HTTPS protocol, never with unsecured HTTP, and therefore can't easily be accessed by a man-in-the-middle attacker. Insecure sites (with http: in the URL) can't set cookies with the Secure attribute.

sameSitestring nullable

The sameSite attribute lets servers require that a cookie shouldn't be sent with cross-origin requests (where Site is defined by the registrable domain), which provides some protection against cross-site request forgery attacks (CSRF). It takes three possible values: Strict, Lax, and None.With Strict, the cookie is sent only to the same site as the one that originated it; Lax is similar, with an exception for when the user navigates to a URL from an external site, such as by following a link; None has no restrictions on cross-site requests.

expirationDateinteger nullable

This attribute is used to set persistent cookies. It signifies how long the browser should use the persistent cookie and when the cookie should be deleted. If this attribute is not specified, then the lifetime of the cookie is the same as that of browser session, i.e.it will be a non-persistent cookie.

Example request

[
  {
    "domain": ".google.com",
    "name": "_ga",
    "path": "/gmail/about",
    "value": "GA1.2-3.982544754.9825342343",
    "httpOnly": true,
    "secure": true,
    "sameSite": "unspecified",
    "expirationDate": 1568986993
  }
]

Response

OK.

domainstring required

The domain attribute signifies the domain for which the cookie is valid and can be submitted with every request for this domain or its subdomains. If this attribute is not specified, then the hostname of the originating server is used as the default value.

namestring required

The name for the Cookie.

pathstring required

The path attribute indicates a URL path that must exist in the requested URL in order to send the Cookie header. The %x2F ("/") character is considered a directory separator, and subdirectories match as well.

valuestring required

The value of the Cookie.

hostOnlyboolean required

Host Only cookie means that the cookie should be handled by the browser to the server only to the same host/server that firstly sent it to the browser.

httpOnlyboolean required

When this attribute is set, client-side scripts are not allowed to access the cookie.

secureboolean required

A cookie with the Secure attribute is sent to the server only with an encrypted request over the HTTPS protocol, never with unsecured HTTP, and therefore can't easily be accessed by a man-in-the-middle attacker. Insecure sites (with http: in the URL) can't set cookies with the Secure attribute.

sameSitestring required

The sameSite attribute lets servers require that a cookie shouldn't be sent with cross-origin requests (where Site is defined by the registrable domain), which provides some protection against cross-site request forgery attacks (CSRF). It takes three possible values: Strict, Lax, and None.With Strict, the cookie is sent only to the same site as the one that originated it; Lax is similar, with an exception for when the user navigates to a URL from an external site, such as by following a link; None has no restrictions on cross-site requests.

expirationDateinteger nullable

This unix timestamp formatted attribute is used to set persistent cookies. It signifies how long the browser should use the persistent cookie and when the cookie should be deleted. If this attribute is not specified, then the lifetime of the cookie is the same as that of browser session, i.e.it will be a non-persistent cookie.

sessionboolean

Session cookies are deleted when the current session ends. The browser defines when the "current session" ends, and some browsers use session restoring when restarting, which can cause session cookies to last indefinitely long.

storeIdstring nullable

The ID of the cookie store containing this cookie.

Example response

[
  {
    "domain": ".google.com",
    "name": "_ga",
    "path": "/gmail/about",
    "value": "GA1.2-3.982544754.9825342343",
    "httpOnly": true,
    "secure": true,
    "sameSite": "unspecified",
    "expirationDate": 1568986993,
    "storeId": "0"
  }
]