Delete Cookie
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
The Delete Cookie command of the WebDriver API deletes the cookie with the given name from the cookie store associated with the current browsing context's active document.
Syntax
| Method | URI template |
|---|---|
DELETE |
/session/{session id}/cookie/{name} |
URL parameters
session id-
Identifier of the session.
name-
The name of the cookie to delete.
Return value
null if successful. The command succeeds even if no cookie matching the given name exists.
Errors
No such window-
The
windowobject has been discarded, indicating that the tab or window has been closed. Unexpected alert open-
A user prompt, such as
window.alert, blocks execution of the command until it is dealt with. Invalid session id-
Session does not exist.
Examples
Deleting a cookie by name
With a WebDriver server running on localhost:4444, assume an active session has a session_token cookie set. To delete it, append the cookie name to the endpoint, replacing ID with the sessionId from the New Session response:
curl -i -X DELETE http://localhost:4444/session/ID/cookie/session_token
The server responds with a null value to indicate success:
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
{"value":null}
Specifications
| Specification |
|---|
| WebDriver # delete-cookie |