Appium Server

Start an Appium server that runs next to the device.

Starts a hosted Appium server co-located with the device. Once started, the response includes the Appium server URL that you can use with any Appium client. Optionally specify an Appium version — use listAppiumVersions to see available versions. If omitted, the platform default version is used.

post/sessions/{sessionId}/appiumserver

Request

Base URL
https://api.us-west-1.saucelabs.com/rdc/v2
Auth
HTTP basic
TypeScript
https://skmtc.dev/saucelabs/apis/real-device-access-api-reference/docs/sessions/:sessionId/appiumserver/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

sessionIdstring required

The id of the device session

Request body

appiumVersionstring

The Appium version to use. If omitted, the platform default version is used. Use GET /appium/versions to list available versions. See https://docs.saucelabs.com/mobile-apps/automated-testing/appium/appium-versions/#real-devices

Example request

{
  "appiumVersion": "appium2-202501010004"
}

Response

Command executed successfully

urlstring

The hosted appium server endpoint associated to this session

versionstring

The hosted appium server version

Example response

{
  "url": "https://api.us-west-1.saucelabs.com/rdc/v2/sessions/2fe09ae3-5d01-4712-bfc0-1d873d20e554/appium/wd/hub",
  "version": "stable"
}

Changes

No recorded changes to this operation across all 1 revision of this API.