Skip to main content
Transform your testing process with: Real Device Features, Company-wide Licences, & App Percy

Set Appium version

BrowserStack supports multiple versions of Appium server including the latest releases. Use latest Appium versions to incorporate new features, enhancements, stability fixes into your tests executed on BrowserStack. If the Appium version is not explicitly specified, the default appium version is selected, depending on the OS and OS version.
Use the Appium version capability as shown in the following table and examples:

If you are using BrowserStack SDK, you can set the following capabilities in the browserstack.yml file:

Capability Description Values
appiumVersion Set the Appium version in your test script Android: 1.15.0 , 1.16.0 , 1.17.0, 1.18.0, 1.19.1, 1.20.2, 1.21.0, 1.22.0, 2.0.1, 2.4.1

iOS: 1.15.0, 1.16.0, 1.17.0, 1.18.0, 1.19.1, 1.20.2, 1.21.0, 1.22.0 , 2.0.1, 2.4.1

You can refer to our Appium Capability builder for more details.
browserstack.yml
Copy icon Copy snippet

BrowserStack SDK is a plug-n-play solution that takes care of all the integration steps for you. Using the BrowserStack SDK is the recommended integration method for your project. To know more, visit the SDK core concepts page.

Capability Description Values
appiumVersion Set the Appium version in your test script Android: 1.15.0 , 1.16.0 , 1.17.0, 1.18.0, 1.19.1, 1.20.2, 1.21.0, 1.22.0, 2.0.1, 2.4.1

iOS: 1.15.0, 1.16.0, 1.17.0, 1.18.0, 1.19.1, 1.20.2, 1.21.0, 1.22.0 , 2.0.1, 2.4.1

You can refer to our Appium Capability builder for more details.

Example:

DesiredCapabilities capabilities = new DesiredCapabilities();
HashMap<String, Object> browserstackOptions = new HashMap<String, Object>();
browserstackOptions.put("appiumVersion", "2.4.1");
capabilities.setCapability("bstack:options", browserstackOptions);
var capabilities = {
'bstack:options' : {
		"appiumVersion" : "2.4.1",
	},
}
AppiumOptions capabilities = new AppiumOptions();
Dictionary<string, object> browserstackOptions = new Dictionary<string, object>();
browserstackOptions.Add("appiumVersion", "2.4.1");
capabilities.AddAdditionalCapability("bstack:options", browserstackOptions);
$caps = array(
'bstack:options' => array(
        "appiumVersion" => "2.4.1",
    ),
)
desired_cap = {
'bstack:options' : {
		"appiumVersion" : "2.4.1",
	},
}
capabilities = {
'bstack:options' => {
        "appiumVersion" => "2.4.1",
    },
}
Capability Description Values
browserstack.appium_version Set the Appium version in your test script Android: 1.15.0 , 1.16.0 , 1.17.0, 1.18.0, 1.19.1, 1.20.2, 1.21.0, 1.22.0

iOS: 1.7.0, 1.15.0 , 1.16.0, 1.17.0, 1.18.0, 1.19.1, 1.20.2, 1.21.0, 1.22.0

You can refer to our Appium Capability builder for more details.

Example:

DesiredCapabilities desiredCapabilities = new DesiredCapabilities();
desiredCapabilities.setCapability("browserstack.appium_version", "1.22.0");
var capabilities = {
"browserstack.appium_version" : "1.22.0",
}
AppiumOptions capabilities = new AppiumOptions();
capabilities.AddAdditionalCapability("browserstack.appium_version", "1.22.0");
$caps = array(
"browserstack.appium_version" => "1.22.0"
)
desired_cap = {
"browserstack.appium_version" : "1.22.0"
}
caps = Selenium::WebDriver::Remote::Capabilities.new
caps["browserstack.appium_version"] = "1.22.0"

If you do not specify an Appium Version for your test, we automatically default to the version of Appium that is compatible with your selected OS and device combination. We keep on updating our default Appium versions to ensure stability of the tests for our users.

Appium 2.x versions

Appium Versions Supported Driver Versions Supported OS Versions
2.4.1 appium - 2.4.1
XCUITest - 5.14.0
UIAutomator2 - 2.42.1
Flutter - 2.3.0
Android: 8 & above
iOS: 15 & above
2.0.1 appium - 2.0.1
XCUITest - 4.32.23
UIAutomator2 - 2.29.2
Flutter - 1.18.1
Android: 8 & above
iOS: 14 & above

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback

Is this page helping you?

Yes
No

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback!

Talk to an Expert
Download Copy