cookies.set()

The set() method of the cookies API sets a cookie containing the specified cookie data. This method is equivalent to issuing an HTTP Set-Cookie header during a request to a given URL.

The call succeeds only if you include the "cookies" API permission in your manifest.json file, as well as host permissions for the given URL specified in its manifest. The given URL also needs the necessary permissions to create a cookie with the given parameters.

This is an asynchronous function that returns a Promise.

Syntax

var setting = browser.cookies.set(
  details               // object
)

Parameters

details

An object containing the details of the cookie you wish to set. It can have the following properties:

domainOptional

A string representing the domain of the cookie. If omitted, the cookie becomes a host-only cookie.

expirationDateOptional

A number that represents the expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie.

firstPartyDomainOptional

A string representing the first-party domain with which the cookie to will be associated. This property must be supplied if the browser has first-party isolation enabled. See First-party isolation.

httpOnlyOptional

A boolean that specifies whether the cookie should be marked as HttpOnly (true), or not (false). If omitted, it defaults to false.

nameOptional

A string representing the name of the cookie. If omitted, this is empty by default.

pathOptional

A string representing the path of the cookie. If omitted, this defaults to the path portion of the URL parameter.

sameSiteOptional

A cookies.SameSiteStatus value that indicates the SameSite state of the cookie. If omitted, it defaults to 0, 'no_restriction'.

secureOptional

A boolean that specifies whether the cookie should be marked as secure (true), or not (false). If omitted, it defaults to false.

storeIdOptional

A string representing the ID of the cookie store in which to set the cookie. If omitted, the cookie is set in the current execution context's cookie store by default.

url

A string representing the request-URI to associate with the cookie. This value can affect the default domain and path values of the created cookie. If host permissions for this URL are not specified in the manifest file, the method call will fail.

valueOptional

A string representing the value of the cookie. If omitted, this is empty by default.

Return value

A Promise that will be fulfilled with a cookies.Cookie object containing details about the cookie that's been set. If the call fails for any reason, the promise will be rejected with an error message.

Browser compatibility

Examples

This example sets a cookie for the document hosted by the currently active tab:

var getActive = browser.tabs.query({active: true, currentWindow: true});
getActive.then(setCookie);

function setCookie(tabs) {
  browser.cookies.set({
    url: tabs[0].url,
    name: "favorite-color",
    value: "red"
  });
}

Example extensions

• cookie-bg-picker