Retrieve Device Settings

Retrieve the current settings on the device

Example Usage

// Java
Map<String, Object> settings = driver.getSettings();

# Python

// Javascript
// example
let settings = driver.settings();

// wd example
await driver.settings();

# Ruby
# ruby_lib example

# ruby_lib_core example

// Not supported
// Not supported


Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest 9.3+ 1.6.0+ All
UIAutomation 8.0 to 9.3 All All
Android Espresso ?+ 1.9.0+ All
UiAutomator2 ?+ 1.6.0+ All
UiAutomator 4.2+ All All
Mac Mac ?+ 1.6.4+ All
Windows Windows 10+ 1.6.0+ All

Appium Clients

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

HTTP API Specifications


GET /wd/hub/session/:session_id/appium/settings

URL Parameters

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

JSON Parameters



a JSON hash of all the currently specified settings, see Settings API. (array<object>)

See Also