Pull Folder

Retrieve a folder from the device's file system

Example Usage

// Java
byte[] folder = driver.pullFolder("/path/to/device/foo.bar");

# Python
folder_base64 = self.driver.pull_folder('/path/to/device/foo.bar');

// Javascript
// webdriver.io example
let data = driver.pullFolder('/data/local/tmp/file.txt');

// wd example
let folderBase64 = await driver.pullFolder('/path/to/device/foo.bar');

# Ruby
# ruby_lib example

# ruby_lib_core example

$folderBase64 = $driver->pullFolder($path);

// C#
// TODO C# sample


Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest 9.3+ 1.6.0+ All
UIAutomation 8.0 to 9.3 All All
Android Espresso ?+ 1.9.0+ All
UiAutomator2 ?+ 1.6.0+ All
UiAutomator 4.2+ All All
Mac Mac None None None
Windows Windows None None None

Appium Clients

Language Support Documentation
Java All appium.github.io
Python All github.com
Javascript (WebdriverIO) All
Javascript (WD) All github.com
Ruby All www.rubydoc.info
PHP All github.com
C# All github.com

HTTP API Specifications


POST /wd/hub/session/:session_id/appium/device/pull_folder

URL Parameters

name description
session_id ID of the session to route the command to

JSON Parameters

name type description
path string Path to an entire folder on the device


A string of Base64 encoded data, representing a zip archive of the contents of the requested folder. (string)

See Also