Device File Management

Pull a file from the device

Retrieves a file from the device storage as a binary stream.

post/sessions/{sessionId}/device/pullFile

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

pathstring required

The absolute path of the file on the device to retrieve.

bundleIdstring

The iOS app bundle identifier (e.g., com.example.app). Required for iOS devices, not needed for Android. On iOS, each app runs in its own sandbox — an isolated file system container that restricts access to only that app's data. This means you must specify which app's sandbox to operate on by providing its bundle ID. You can find the bundle ID in Xcode, in the app's Info.plist, or via the Sauce Labs app management API. See Apple's File System documentation for more details.

Example request

{
  "path": "/Download/report.txt",
  "bundleId": "com.example.app"
}

Response

File retrieved successfully

Changes

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