cookies

Get and set cookies, and be notified when they change.

To use this API, you need to have the "cookies" API permission as well as host permissions for the sites whose cookies you need to access. See cookie Permissions.

Types

cookies.Cookie
Represents information about an HTTP cookie.
cookies.CookieStore
Represents a cookie store in the browser. An incognito mode window, for instance, uses a separate cookie store from a non-incognito window.
cookies.OnChangedCause
The underlying reason behind the cookie's change. It may be one of:
"explicit"
A cookie was inserted or removed explicitly via a Set-Cookie header, or an API call such as cookies.set or cookies.remove.
"expired"
A cookie was removed automatically, due to expiry.
"expired_overwrite"
A cookie was removed because it was overwritten by a cookie with a cookie with an expiration date in the past.
"evicted"
A cookie was automatically removed due to storage quotas.
"overwrite"
A cookie was automatically removed because it was overwritten by a new cookie with the same parameters.

Functions

cookies.get()
Retrieves information about a single cookie. If more than one cookie of the same name exists for the given URL, the one with the longest path will be returned. For cookies with the same path length, the cookie with the earliest creation time will be returned.
cookies.getAll()
Retrieves all cookies from a single cookie store that match the given information. The cookies returned will be sorted, with those with the longest path first. If multiple cookies have the same path length, those with the earliest creation time will be first.
cookies.set()
Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.
cookies.remove()
Deletes a cookie by name.
cookies.getAllCookieStores()
Lists all existing cookie stores.

Events

cookies.onChanged
Fired when a cookie is set or removed. As a special case, note that updating a cookie's properties is implemented as a two step process: the cookie to be updated is first removed entirely, generating a notification with "cause" of "overwrite". Afterwards, a new cookie is written with the updated values, generating a second notification with a "cause" of "explicit".

Permissions

In order to use this API, an add-on must specify the "cookies" API permission in its manifest, along with host permissions for any sites for which it wishes to access cookies. The add-on may read or write any cookies which could be read or written by a URL matching the host permissions. For example:

http://*.example.com/

An add-on with this host permission may:

  • Read a non-secure cookie for www.example.com, with any path.
  • Write a secure or non-secure cookie for www.example.com with any path.

It may not:

  • Read a secure cookie for www.example.com.
http://www.example.com/

An add-on with this host permission may:

  • Read a non-secure cookie for www.example.com, with any path.
  • Read a non-secure cookie for .example.com, with any path.
  • Write a secure or non-secure cookie for www.example.com with any path.
  • Write a secure or non-secure cookie for .example.com with any path.

It may not:

  • Read or write a cookie for foo.example.com.
  • Read or write a cookie for foo.www.example.com.
*://*.example.com/

An add-on with this host permission may:

  • Read or write a secure or non-secure cookie for www.example.com with any path.

Browser compatibility

EdgeFirefoxChromeOpera
Cookie?45.0Yes33
CookieStore?45.0Yes33
OnChangedCause?45.0Yes33
get?45.0Yes33
getAll?45.0Yes33
getAllCookieStores?45.0Yes33
onChanged?45.0Yes33
remove?45.0Yes33
set?45.0Yes33
Firefox
Cookie48.0
CookieStore48.0
OnChangedCause48.0
get48.0
getAll48.0
getAllCookieStores48.0
onChanged48.0
remove48.0
set48.0

Chrome incompatibilities

  • In Firefox:
    • onChanged events might be subtly different
    • getAllCookieStores always just returns one default store and no tabs
    • accessing cookies from private tabs is impossible

Acknowledgements

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

Document Tags and Contributors

 Contributors to this page: wbamberg, kmaglione, jpmedley, evilpie
 Last updated by: wbamberg,