Private Devices using XCUITest
Run your XCUITest tests on Private Devices using BrowserStack App Automate
To run XCUITest tests on Private Devices hosted on BrowserStack’s private cloud, use the same REST API endpoint and workflow described in the XCUITest documentation, with a few additional parameters specific to private devices.
Prerequisites
-
Ensure you have a BrowserStack Username and Access Key. You can obtain your
username
andaccess key
from the Account & Profile section on the dashboard.
If you have not yet created an account, sign up for a Free Trial. -
Upload your application and test suite.
Key differences from public cloud
The overall workflow is the same, but you need to include the following additional parameters in your REST API request to target private devices.
Sample API request using Private Devices to execute your test
The table below explains the parameters used in the REST API request:
Parameter | Required | Description |
---|---|---|
dedicatedDevice |
Yes | Set this to true to indicate that the test should run on a private device. This tells BrowserStack to route the test to your private device pool instead of the public cloud. |
deviceId |
Yes | The deviceId is the same as UDID. It is a unique identifier of the private device on which you want to run the test. You can retrieve this ID from your private device pool dashboard or through your account representative. |
devices |
Yes | An array specifying the device name and OS version in the format "deviceName-deviceOSVersion" (e.g., "Samsung Galaxy S21-11.0" ). While this field is optional when deviceId is provided, it can be useful for logging or organizational purposes. |
Next steps
- View test results on App Automate dashboard along with debugging logs, and overall test details.
- Refer to the XCUITest API reference for a full list of available capabilities and endpoints.
- Visit the Private devices documentation to learn how to manage and monitor your dedicated devices.
- Contact BrowserStack support if you need help configuring tests for private devices.
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
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!