The Cookie type of the cookies API represents information about an HTTP cookie.


Values of this type are objects, which can contain the following properties:

A string representing the name of the cookie.
A string representing the value of the cookie.
A string representing the domain the cookie belongs to (e.g. "", "").
A boolean, true if the cookie is a host-only cookie (i.e. the request's host must exactly match the domain of the cookie), or false otherwise.
A string representing the path of the cookie.
A boolean, true if the cookie is marked as secure (i.e. its scope is limited to secure channels, typically HTTPS), or false otherwise.
A boolean, true if the cookie is marked as HttpOnly (i.e. the cookie is inaccessible to client-side scripts), or false otherwise.
A boolean, true if the cookie is a session cookie, or false if it is a persistent cookie with an expiration date.
A number representing the expiration date of the cookie as the number of seconds since the UNIX epoch. Not provided for session cookies.
A string representing the ID of the cookie store containing this cookie, as provided by cookies.getAllCookieStores().

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic Support Yes Yes 45.0 48.0 33


Most methods in the cookies API involve a Cookie object being used either as an input parameter, or as part of the return value. For example, a call to cookies.set() involves a Cookie object being passed in to provide the details of the cookie you want to set.

In this code snippet, taken from our cookie-bg-picker example, a function is run when the color picker form input has a new color entered into it. The tabs.query() method is first used to get information about the current tab, after which tabs.sendMessage() is used to send the new color choice to the content script so it can update the background of the page with the new color, and cookies.set() is used to save that preference in a cookie.

colorPick.onchange = function(e) {
  chrome.tabs.query({active: true, currentWindow: true}, function(tabs) {
    var currColor =;
    chrome.tabs.sendMessage(tabs[0].id, {color: currColor});

    cookieVal.color = currColor;
      url: tabs[0].url,
      name: "bgpicker",
      value: JSON.stringify(cookieVal)

The cookie object here is as follows:

  url: tabs[0].url,
  name: "bgpicker",
  value: JSON.stringify(cookieVal)

Example add-ons


This API is based on Chromium's chrome.cookies API. This documentation is derived from cookies.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: wbamberg, chrisdavidmills
 Last updated by: wbamberg,