This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.

  Edit this Doc Set Cookie

Set a cookie (Web context only)

Example Usage

driver.manage().addCookie(new Cookie("foo", "bar"));

self.driver.add_cookie({name: 'foo', value: 'bar'})

// example
  name: 'myCookie',
  value: 'some content'

// wd example
let cookies = await driver.setCookie({name: 'foo', value: 'bar'});

# ruby_lib example
manage.add_cookie(:name => 'foo', :value => 'bar')

# ruby_lib_core example
@driver.manage.add_cookie(:name => 'foo', :value => 'bar')

driver.Manage().Cookies.AddCookie(new Cookie("foo", "bar"));


Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest None None None
UIAutomation None None None
Android UiAutomator2 None None None
Espresso None None None
UiAutomator None None None
Mac Mac None None None
Windows Windows None None None

Appium Clients

Language Support Documentation
Java All
Python All
Javascript (WebdriverIO) All
Javascript (WD) All
Ruby All
C# All

HTTP API Specifications


POST /session/:sessionId/cookie

URL Parameters

name description
session_id ID of the session to route the command to

JSON Parameters

name type description
cookie object The cookie to add



See Also