Table of Contents
APP AUTOMATE API

Apps

In order to test your native and hybrid apps on BrowserStack using Appium, you first need to upload an Android app (.apk/.aab file) or an iOS app(.ipa file) to BrowserStack servers. Use our REST API endpoints to upload and manage your apps on BrowserStack.

Upload an app

POST /app-automate/upload

Upload the application under test (AUT) for Appium testing. The supported file formats are .apk and .aab files for Android and .ipa file for iOS. There are two ways to upload an app :

  1. Upload from filesystem : Use this option if the app resides on your local machine or CI/CD server. Learn more about uploading app from filesystem.
  2. Upload using public URL : Use this option when the app is hosted on a remote server (e.g. S3 bucket) and its downloadable via a publicly accessible URL. Learn more about uploading app using public URL.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/upload" \
-F "file=@/path/to/app/file/application-debug.apk" \
-F "custom_id=SampleApp"
  • file File

    File to upload. Ensure that the request’s content type is set to multipart/form-data. In cURL, you can do this using -F option. Either file or url parameter is required.

  • url String

    Remote URL to your app. Ensure that its a publicly accessible URL as BrowserStack will attempt to download the app from this location. Either file or url parameter is required.

  • custom_id String

    Custom ID for the app. Refer to our custom ID documentation to know more.

Response attributes 200 application/json

Response

{
    "app_url": "bs://c8ddcb5649a8280ca800075bfd8f151115bba6b3",
    "custom_id": "SampleApp",
    "shareable_id": "steve/SampleApp"
}
  • app_url String

    Unique identifier returned upon successful upload of your app on BrowserStack. This value can be used later to specify the application under test in your Appium test scripts.
    Example: bs://c8ddcb5649a8280ca800075bfd8f151115bba6b3

  • custom_id String

    Custom ID defined for the uploaded app.
    Example: SampleApp

  • shareable_id String

    Shareable ID allows other users in your organization to test an app you uploaded .
    Example: steve/SampleApp

List uploaded apps

GET /app-automate/recent_apps

Retrieve a list of recently uploaded apps. By default, it returns the last 10 apps uploaded by the user on BrowserStack.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api-cloud.browserstack.com/app-automate/recent_apps"

# List recent apps using customID
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api-cloud.browserstack.com/app-automate/recent_apps/SampleApp"
  • custom_id String

    Filter uploaded apps by custom ID.

Response attributes 200 application/json

Response

[
    {
        "app_name": "app-debug.apk",
        "app_version": "1.2.0",
        "app_url": "bs://c8ddcb5649a8280ca800075bfd8f151115bba6b3",
        "app_id": "c8ddcb5649a8280ca800075bfd8f151115bba6b3",
        "uploaded_at": "2020-05-05 14:52:54 UTC",
        "custom_id": "SampleApp",
        "shareable_id": "steve/SampleApp"
    },
    {...}
]
  • Array

    List of recently uploaded apps.

    SHOW VALUES
    • app_name String

      Filename of the uploaded app.

    • app_version String

      Version of the uploaded app.

    • app_url String

      Unique identifier returned upon successful upload of your app on BrowserStack. This value can be used later to specify the application under test in your Appium test scripts.
      Example: bs://c8ddcb5649a8280ca800075bfd8f151115bba6b3

    • app_id String

      Unique identifier returned upon successful upload of your app on BrowserStack.
      Example: c8ddcb5649a8280ca800075bfd8f151115bba6b3

    • uploaded_at String

      App upload timestamp.

    • custom_id String

      Custom ID defined for the uploaded app.
      Example: SampleApp.

    • shareable_id String

      Shareable ID allows other users in your organization to test an app you uploaded .
      Example: steve/SampleApp.

List uploaded apps by group

GET /app-automate/recent_group_apps

Retrieve a list of recently uploaded apps. It returns the last 10 uploaded apps from your BrowserStack group.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api-cloud.browserstack.com/app-automate/recent_group_apps"

No parameter required.

Response attributes 200 application/json

Response

[
    {
        "app_name": "app-debug.apk",
        "app_version": "1.2.0",
        "app_url": "bs://c8ddcb5649a8280ca800075bfd8f151115bba6b3",
        "app_id": "c8ddcb5649a8280ca800075bfd8f151115bba6b3",
        "uploaded_at": "2020-05-05 14:52:54 UTC",
        "custom_id": "SampleApp",
        "shareable_id": "steve/SampleApp"
    },
    {...}
]
  • Array

    List of recently uploaded apps.

    SHOW VALUES
    • app_name String

      Filename of the uploaded app.

    • app_version String

      Version of the uploaded app.

    • app_url String

      Unique identifier returned upon successful upload of your app on BrowserStack. This value can be used later to specify the application under test in your Appium test scripts.
      Example: bs://c8ddcb5649a8280ca800075bfd8f151115bba6b3

    • app_id String

      Unique identifier returned upon successful upload of your app on BrowserStack.
      Example: c8ddcb5649a8280ca800075bfd8f151115bba6b3

    • uploaded_at String

      App upload timestamp.

    • custom_id String

      Custom ID defined for the uploaded app.
      Example: SampleApp.

    • shareable_id String

      Shareable ID allows other users in your organization to test an app you uploaded .
      Example: steve/SampleApp.

Delete an app

DELETE /app-automate/app/delete/{appID}

Delete an app that was previously uploaded to BrowserStack.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X DELETE "https://api-cloud.browserstack.com/app-automate/app/delete/c8ddcb5649a8280ca800075bfd8f151115bba6b3"
  • appID* String

    The app ID of the uploaded app

Response attributes 200 application/json

Response

{
    "success": true
}
  • success Boolean

    Confirmation that app is successfully deleted from BrowserStack servers.

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