Device Interactions

Launch WDA installed on the device

Launches WebDriverAgent (WDA) on an iOS device. WDA enables Appium-based automation by providing a WebDriver-compatible interface to the device. Please use the installApp endpoint to provide your own WDA binary and use getWebDriverAgentStatus to check if WDA is running. After launching, you can interact with the newly installed WDA using the HTTP Proxy endpoints provided by this API.

post/sessions/{sessionId}/device/launchWebDriverAgent

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/device/launchWebDriverAgent/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

bundleIdstring

Bundle identifier of the installed WDA

Example request

{
  "bundleId": "com.facebook.WebDriverAgent"
}

Response

Command executed successfully

bundleIdstring

Bundle identifier of the running WDA

devicePortnumber

Port of WDA running in the device

hostPortnumber

Forwarded WDA for hosted appium use

state'PENDING' | 'LAUNCHING' | 'RUNNING' | 'ERROR'

errorstring

Example response

{
  "bundleId": "com.facebook.WebDriverAgent",
  "devicePort": 18100,
  "hostPort": 5900
}

Changes

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