Device Interactions

Get launching status for WDA

Returns the current state of WebDriverAgent on the device. The state can be PENDING, LAUNCHING, RUNNING, or ERROR. When RUNNING, the response includes the device port and host port for connecting automation tools. Use this to poll after calling launchWebDriverAgent to confirm WDA is ready.

post/sessions/{sessionId}/device/checkWebDriverAgentStatus

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/checkWebDriverAgentStatus/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

object required

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.