Clear-Site-Data

{{securecontext_header}} {{HTTPSidebar}} 

The HTTP Clear-Site-Data {{Glossary("response header")}}  sends a signal to the client that it should remove all browsing data of certain types (cookies, storage, cache) associated with the requesting website. It allows web developers to have more control over the data stored by browsers for their origins.

Syntax

// Single directive
Clear-Site-Data: "cache"

// Multiple directives (comma separated)
Clear-Site-Data: "cache", "cookies"

// Wild card
Clear-Site-Data: "*"

Directives

[!NOTE] All directives must comply with the quoted-string grammar. A directive that does not include the double quotes is invalid.

• "cache"

  • : The server signals that the client should remove locally cached data (the browser cache, see HTTP caching) for the origin of the response URL. Depending on the browser, this might also clear out things like pre-rendered pages, script caches, WebGL shader caches, or address bar suggestions.

• "clientHints" {{Experimental_Inline}} 

  • : Indicates that the server will remove all client hints (requested via {{HTTPHeader("Accept-CH")}} ) stored for the origin of the response URL.

    [!NOTE] In browsers that support the "clientHints" data type, client hints are also cleared when the "cache", "cookies", or "*" types are specified. "clientHints" is therefore only needed when none of those other types are specified.

• "cookies"

  • : The server signals that the client should remove all cookies for the origin of the response URL. HTTP authentication credentials are also cleared out. This affects the entire registered domain, including subdomains. So https://example.com as well as https://stage.example.com, will have cookies cleared.

• "storage"

  • : The server signals that the client should remove all DOM storage for the origin of the response URL. This includes storage mechanisms such as:

    • localStorage (executes localStorage.clear),
    • sessionStorage (executes sessionStorage.clear),
    • IndexedDB (for each database execute {{domxref("IDBFactory.deleteDatabase")}} ),
    • Service worker registrations (for each service worker registration, execute {{domxref("ServiceWorkerRegistration.unregister")}} ),
    • Web SQL databases (deprecated),
    • FileSystem API data,
    • Plugin data (Flash via NPP_ClearSiteData).

• "executionContexts" {{Experimental_Inline}} 

  • : The server signals that the client should reload all browsing contexts for the origin of the response ({{domxref("Location.reload")}} ).

• "*" (wildcard)

  • : The server signals that the client should clear all types of data for the origin of the response. If more data types are added in future versions of this header, they will also be covered by it.

Examples

Sign out of a website

If a user signs out of your website or service, you might want to remove locally stored data. To do this, add the Clear-Site-Data header to the page that confirms the logging out from the site has been accomplished successfully (https://example.com/logout, for example):

Clear-Site-Data: "cache", "cookies", "storage", "executionContexts"

Clearing cookies

If this header is delivered with the response at https://example.com/clear-cookies, all cookies on the same domain https://example.com and any subdomains (like https://stage.example.com, etc.), will be cleared out.

Clear-Site-Data: "cookies"

Specifications

{{Specifications}} 

Browser compatibility

{{Compat}} 

See also

• {{HTTPHeader("Cache-Control")}}