{ "doc": { "id": "api/commands/clearcookie", "title": "cy.clearCookie()", "description": "Clear a specific browser cookie in Cypress.", "section": "api", "source_path": "/llm/markdown/api/commands/clearcookie.md", "version": "f60251bf707b0077a9535579c9f90d615440cc35", "updated_at": "2026-10-16T10:56:58.670Z", "headings": [ { "id": "api/commands/clearcookie#clearcookie", "text": "clearCookie", "level": 1 }, { "id": "api/commands/clearcookie#syntax", "text": "Syntax", "level": 2 }, { "id": "api/commands/clearcookie#usage", "text": "Usage", "level": 3 }, { "id": "api/commands/clearcookie#arguments", "text": "Arguments", "level": 3 }, { "id": "api/commands/clearcookie#yields", "text": "Yields", "level": 3 }, { "id": "api/commands/clearcookie#examples", "text": "Examples", "level": 2 }, { "id": "api/commands/clearcookie#name", "text": "Name", "level": 3 }, { "id": "api/commands/clearcookie#clear-a-cookie-after-logging-in", "text": "Clear a cookie after logging in[", "level": 4 }, { "id": "api/commands/clearcookie#clear-an-httponly-session-cookie-and-check-the-api", "text": "Clear an HttpOnly session cookie and check the API[", "level": 4 }, { "id": "api/commands/clearcookie#show-a-cookie-consent-banner-again", "text": "Show a cookie consent banner again[", "level": 4 }, { "id": "api/commands/clearcookie#clear-a-cookie-set-during-a-cy-origin-login", "text": "Clear a cookie set during a cy.origin() login[", "level": 4 }, { "id": "api/commands/clearcookie#clear-one-cookie-before-each-test-with-test-isolation-off", "text": "Clear one cookie before each test with test isolation off[", "level": 4 }, { "id": "api/commands/clearcookie#name-and-options", "text": "Name and options", "level": 3 }, { "id": "api/commands/clearcookie#clear-a-cookie-on-a-specific-domain", "text": "Clear a cookie on a specific domain[", "level": 4 }, { "id": "api/commands/clearcookie#notes", "text": "Notes", "level": 2 }, { "id": "api/commands/clearcookie#clearing-a-cookie-that-doesnt-exist", "text": "Clearing a cookie that doesn't exist", "level": 3 }, { "id": "api/commands/clearcookie#default-cookie-domain-before-visiting-a-page", "text": "Default cookie domain before visiting a page", "level": 3 }, { "id": "api/commands/clearcookie#rules", "text": "Rules", "level": 2 }, { "id": "api/commands/clearcookie#requirements", "text": "Requirements", "level": 3 }, { "id": "api/commands/clearcookie#assertions", "text": "Assertions", "level": 3 }, { "id": "api/commands/clearcookie#timeouts", "text": "Timeouts", "level": 3 }, { "id": "api/commands/clearcookie#command-log", "text": "Command Log", "level": 2 }, { "id": "api/commands/clearcookie#history", "text": "History", "level": 2 }, { "id": "api/commands/clearcookie#see-also", "text": "See also", "level": 2 } ] }, "content": { "type": "root", "children": [ { "type": "heading", "depth": 1, "children": [ { "type": "text", "value": "clearCookie" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Clear a specific browser cookie." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Cypress automatically clears all cookies before each test to prevent state from being shared across tests when " }, { "type": "link", "title": null, "url": "/llm/markdown/app/core-concepts/writing-and-organizing-tests.md#Test-Isolation", "children": [ { "type": "text", "value": "test isolation" } ] }, { "type": "text", "value": " is enabled. You shouldn't need to use this command unless you're using it to clear a specific cookie inside a single test or test isolation is disabled." } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Syntax" } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.clearCookie(name)\ncy.clearCookie(name, options)" }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Usage" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Correct Usage" } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.clearCookie('authId') // clear the 'authId' cookie" }, { "type": "paragraph", "children": [ { "type": "text", "value": "Incorrect Usage" } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.clearCookie() // Errors, a cookie name is required\ncy.clearCookie({ domain: 'example.com' }) // Errors, name must be a string" }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Arguments" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "name (String)" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "The name of the cookie to clear. Required, and must be a string." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "options (Object)" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Pass in an options object to change the default behavior of `cy.clearCookie()`." } ] }, { "type": "table", "align": [ null, null, null ], "children": [ { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "Option" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Default" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Description" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`domain`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Hostname of the application under test" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Clears the cookie from the specified domain" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`log`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`true`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Displays the command in the " }, { "type": "link", "title": null, "url": "/llm/markdown/app/core-concepts/open-mode.md#Command-Log", "children": [ { "type": "text", "value": "Command log" } ] } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`timeout`" } ] }, { "type": "tableCell", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/app/references/configuration.md#Timeouts", "children": [ { "type": "text", "value": "`responseTimeout`" } ] } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Time to wait for `cy.clearCookie()` to resolve before " }, { "type": "link", "title": null, "url": "#Timeouts", "children": [ { "type": "text", "value": "timing out" } ] } ] } ] } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Yields" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`cy.clearCookie()` yields `null`." } ] } ] } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Examples" } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Name" } ] }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Clear a cookie after logging in[" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "End-to-End Only" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "](/llm/markdown/app/core-concepts/testing-types.md#What-is-E2E-Testing)" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "In this example, your server sends back a session cookie on login. `cy.clearCookie('session_id')` removes that cookie, so when you visit a page that requires authentication, the server redirects you back to the login page." } ] }, { "type": "code", "lang": null, "meta": null, "value": "// assume the user just logged in\ncy.contains('Login').click()\ncy.url().should('include', 'profile')\ncy.clearCookie('session_id')\ncy.visit('/dashboard') // redirected back to login\ncy.url().should('include', 'login')" }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Clear an HttpOnly session cookie and check the API[" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "End-to-End Only" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "](/llm/markdown/app/core-concepts/testing-types.md#What-is-E2E-Testing)" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Your application's own JavaScript can't read or remove an `HttpOnly` cookie through `document.cookie`. `cy.clearCookie()` clears cookies through the browser's automation layer, so it removes `HttpOnly` cookies too. Clear the session cookie, then confirm the API rejects the next request." } ] }, { "type": "code", "lang": null, "meta": null, "value": "// session_id is HttpOnly, so document.cookie can't remove it\ncy.clearCookie('session_id')\ncy.request({ url: '/api/profile', failOnStatusCode: false })\n .its('status')\n .should('eq', 401)" }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Show a cookie consent banner again[" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "End-to-End Only" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "](/llm/markdown/app/core-concepts/testing-types.md#What-is-E2E-Testing)" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Clear a single cookie and reload to test a first-visit flow, such as a cookie consent banner, without logging out. Every other cookie stays in place." } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.clearCookie('cookie_consent')\ncy.reload()\ncy.get('[data-cy=\"consent-banner\"]').should('be.visible')" }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Clear a cookie set during a cy.origin() login[" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "End-to-End Only" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "](/llm/markdown/app/core-concepts/testing-types.md#What-is-E2E-Testing)" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "When you log in through another origin with " }, { "type": "link", "title": null, "url": "/llm/markdown/api/commands/origin.md", "children": [ { "type": "text", "value": "`cy.origin()`" } ] }, { "type": "text", "value": ", the identity provider often redirects back to your application, which then sets its own session cookie. Once `cy.origin()` returns, `cy.clearCookie()` clears that cookie from the application under test." } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.visit('/')\ncy.get('[data-cy=\"login\"]').click()\ncy.origin('https://auth.example.com', () => {\n cy.get('[data-cy=\"username\"]').type('user')\n cy.get('[data-cy=\"password\"]').type('*****')\n cy.get('[data-cy=\"submit\"]').click()\n})\ncy.clearCookie('user')\ncy.reload() // the app shows the logged-out state" }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Clear one cookie before each test with test isolation off[" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "End-to-End Only" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "](/llm/markdown/app/core-concepts/testing-types.md#What-is-E2E-Testing)" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "With " }, { "type": "link", "title": null, "url": "/llm/markdown/app/core-concepts/test-isolation.md", "children": [ { "type": "text", "value": "test isolation" } ] }, { "type": "text", "value": " turned off, cookies from one test carry over to the next. Call `cy.clearCookie()` in a `beforeEach` hook to reset only the cookie you care about while keeping the rest, such as a login session you want to reuse across the suite." } ] }, { "type": "code", "lang": null, "meta": null, "value": "describe('Onboarding tour', { testIsolation: false }, () => {\n before(() => {\n // log in once; the session cookie carries over between tests\n cy.visit('/login')\n cy.get('[data-cy=\"username\"]').type('user')\n cy.get('[data-cy=\"password\"]').type('*****')\n cy.get('[data-cy=\"submit\"]').click()\n cy.url().should('include', '/dashboard') // wait for the login to finish\n })\n\n beforeEach(() => {\n // keep the session cookie, but start each test before the tour is dismissed\n cy.clearCookie('tour_dismissed')\n })\n\n it('shows the tour on the dashboard', () => {\n cy.visit('/dashboard')\n cy.get('[data-cy=\"tour\"]').should('be.visible')\n })\n})" }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Name and options" } ] }, { "type": "heading", "depth": 4, "children": [ { "type": "text", "value": "Clear a cookie on a specific domain[" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "End-to-End Only" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "](/llm/markdown/app/core-concepts/testing-types.md#What-is-E2E-Testing)" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "By default, `cy.clearCookie()` clears the cookie from the hostname of the application under test. Pass `domain` to clear a cookie set on a different domain." } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.clearCookie('session_id', { domain: 'auth.example.com' })\ncy.getCookie('session_id', { domain: 'auth.example.com' }).should('be.null')" }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Notes" } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Clearing a cookie that doesn't exist" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "`cy.clearCookie()` doesn't fail when no cookie matches the name. It still yields `null`, and the console output for the command notes that no cookie with that name was found or removed." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Default cookie domain before visiting a page" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "The `domain` option defaults to the hostname of the application under test. Before " }, { "type": "link", "title": null, "url": "/llm/markdown/api/commands/visit.md", "children": [ { "type": "text", "value": "`cy.visit()`" } ] }, { "type": "text", "value": " loads a page, the application under test is on `about:blank`, so Cypress uses the hostname it serves the spec from instead (usually `localhost`). Pass `domain` explicitly to work with cookies on another domain before visiting." } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Rules" } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Requirements" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`cy.clearCookie()` requires being chained off of `cy`." } ] } ] } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Assertions" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`cy.clearCookie()` yields `null`, so there's nothing to assert on. To confirm the cookie is cleared, assert on " }, { "type": "link", "title": null, "url": "/llm/markdown/api/commands/getcookie.md", "children": [ { "type": "text", "value": "`cy.getCookie()`" } ] }, { "type": "text", "value": " afterward, for example `cy.getCookie('session_id').should('be.null')`." } ] } ] } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Timeouts" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "`cy.clearCookie()` can time out waiting for the browser to clear the cookie. It waits up to the " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/configuration.md#Timeouts", "children": [ { "type": "text", "value": "`responseTimeout`" } ] }, { "type": "text", "value": " (or the `timeout` option, when passed) before failing." } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "text", "value": "If the application under test is on a different origin, `cy.clearCookie()` retries for up to the " }, { "type": "link", "title": null, "url": "/llm/markdown/app/references/configuration.md#Timeouts", "children": [ { "type": "text", "value": "`defaultCommandTimeout`" } ] }, { "type": "text", "value": " (or the `timeout` option, when passed) and then fails with a cross-origin error. Run it inside " }, { "type": "link", "title": null, "url": "/llm/markdown/api/commands/origin.md", "children": [ { "type": "text", "value": "`cy.origin()`" } ] }, { "type": "text", "value": " to work with cookies on that origin." } ] } ] } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Command Log" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "Clearing a cookie after setting a cookie" } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.setCookie('foo', 'bar')\ncy.clearCookie('foo')\ncy.getCookie('foo').should('be.null')" }, { "type": "paragraph", "children": [ { "type": "text", "value": "The commands above display in the Command Log as:" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "When you click `clearCookie` in the Command Log, the console outputs the following:" } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "History" } ] }, { "type": "table", "align": [ null, null ], "children": [ { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "Version" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Changes" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/app/references/changelog.md#11-0-0", "children": [ { "type": "text", "value": "11.0.0" } ] } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Added `domain` option." } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/app/references/changelog.md#0-6-8", "children": [ { "type": "text", "value": "0.6.8" } ] } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`cy.clearCookie()` command added." } ] } ] } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "See also" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/api/commands/clearcookies.md", "children": [ { "type": "text", "value": "`cy.clearCookies()`" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/api/commands/clearlocalstorage.md", "children": [ { "type": "text", "value": "`cy.clearLocalStorage()`" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/api/commands/getcookies.md", "children": [ { "type": "text", "value": "`cy.getCookies()`" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/api/commands/getcookie.md", "children": [ { "type": "text", "value": "`cy.getCookie()`" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/api/commands/setcookie.md", "children": [ { "type": "text", "value": "`cy.setCookie()`" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/api/cypress-api/cookies.md", "children": [ { "type": "text", "value": "`Cypress.Cookies.debug()`" } ] } ] } ] } ] } ] }, "token_estimate": 1215 }