Device Interactions

Install an app from App Storage

Install an app on the device. The installation will take place in the background. Use listAppInstallations to query for status.

post/sessions/{sessionId}/device/installApp

Request

Path parameters

sessionIdstring required

The id of the device session

Request body

appstring required

This should be the location of your app in Sauce Labs App Storage Service (e.g., storage:filename=myapp.apk or storage:uuid)

enableInstrumentationboolean

Enable app instrumentation (includes app re-signing for iOS). Required for iOS app installation on cloud devices. Unlocks advanced features on both platforms. Automatically set to true if iOS app uses ad-hoc signing or advanced features are enabled. Setting to false may cause iOS installation failures and disables Android advanced features. Recommended: true.

launchAfterInstallboolean

If set to true, the app will automatically launch after a successful installation.

Example request

{
  "app": "storage:c78ec45e-ea3e-ac6a-b094-00364171addb",
  "enableInstrumentation": true,
  "launchAfterInstall": true
}

Response

Command executed successfully

installationIdstring

Identifier of this app installation process

appstring

This should be the location of your app in Sauce Labs App Storage Service or Ephemeral app (e.g., storage:filename=myapp.apk, storage:uuid, https://www.myserver.com/files/myapp.apk)

status'PENDING' | 'FINISHED' | 'ERROR'

Example response

{
  "app": "storage:c78ec45e-ea3e-ac6a-b094-00364171addb"
}

Changes

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