Skip to main content
Table of Contents
Documentation home icon APP AUTOMATE API

Test Packages

In order to test your iOS test package on BrowserStack using Flutter, you need to upload your test package (.zip file) to BrowserStack servers. Use our REST API endpoints to upload and manage your test package on BrowserStack.

Upload the test package

POST /app-automate/flutter-integration-tests/v2/ios/test-package

Upload the ios test package for Flutter testing. Only .zip file format is supported. You can upload your app using the File System method.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-cloud.browserstack.com/app-automate/flutter-integration-tests/v2/ios/test-package" \
-F "file=@/path/to/app/file/filename.zip" \
-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.

  • custom_id String

    Custom ID for the test package.

Response attributes 200 application/json

Response

{
    "test_package_name": "sample.zip",
    "test_package_url": "bs://c8ddcb5649a8280ca800075bfd8f151115bba6b3",
    "test_package_id": "c8ddcb5649a8280ca800075bfd8f151115bba6b3",
    "uploaded_at": "2020-05-05 14:52:54 UTC",
    "expiry" : "2020-06-05 14:52:54 UTC",
    "framework":"flutter integration tests"
}
  • test_package_name String

    Filename of the uploaded test package.

  • test_package_url String

    Unique identifier returned upon successful upload of your test package on BrowserStack. This value can be used later to specify the application under test for your Flutter test execution.
    Example: bs://c8ddcb5649a8280ca800075bfd8f151115bba6b3

  • test_package_id String

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

  • uploaded_at String

    Test package upload timestamp.

  • expiry String

    By default, an uploaded test package expires in 30 days. Upon expiry, the uploaded test package is deleted from BrowserStack servers and thus can no longer be tested.

  • framework String

    The test framwork. By default, it is flutter integration tests.

List uploaded test packages

GET /app-automate/flutter-integration-tests/v2/ios/test-packages

Retrieve the list of recently uploaded test packages. By default, it returns the last 10 uploaded test packages from your BrowserStack group.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api-cloud.browserstack.com/app-automate/flutter-integration-tests/v2/ios/test-packages"
  • custom_id String

    Filter uploaded test packages by custom ID.

  • scope String

    Show recent test packages at a group level or user level. The possible values:

    Value Description
    group Show test packages uploaded by any user within your BrowserStack group. This is the default behaviour.
    user Show test packages uploaded by you
  • limit String

    Number of recent test packages to fetch. The default value is 10.

Response attributes 200 application/json

Response

{
    "test_packages": [
        {
            "test_package_name": "sample.zip",
            "test_package_url": "bs://c8ddcb5649a8280ca800075bfd8f151115bba6b3",
            "test_package_id": "c8ddcb5649a8280ca800075bfd8f151115bba6b3",
            "uploaded_at": "2020-05-05 14:52:54 UTC",
            "expiry" : "2020-06-05 14:52:54 UTC"
        },
        {...}
    ]
}
  • test_packages Array

    List of recently uploaded test package.

    SHOW VALUES
    • test_package_name String

      Filename of the uploaded test package.

    • test_package_url String

      Unique identifier returned upon successful upload of your test package on BrowserStack. This value can be used later to specify the application under test for your Flutter test execution.
      Example: bs://c8ddcb5649a8280ca800075bfd8f151115bba6b3

    • test_package_id String

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

    • uploaded_at String

      Test package upload timestamp.

    • custom_id String

      Custom ID defined for the uploaded test package.
      Example: SampleApp.

    • shareable_id String

      Shareable ID allows other users in your organization to test the test package you uploaded .
      Example: user/SampleApp.

    • expiry String

      By default, an uploaded test package expires in 30 days. Upon expiry, the uploaded test package is deleted from BrowserStack servers and thus can no longer be tested.

Get test package details

GET /app-automate/flutter-integration-tests/v2/ios/test-package/{packageId}

Get details of the uploaded test package.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api-cloud.browserstack.com/app-automate/flutter-integration-tests/v2/ios/test-package/e8aa63a101c4a789671688633417795a3fa00770"
  • test_packageId* String

    The test package ID of the uploaded package

Response attributes 200 application/json

Response

{
    "test_package": {
        "test_package_name": "sample.zip",
        "test_package_url": "bs://c8ddcb5649a8280ca800075bfd8f151115bba6b3",
        "test_package_id": "c8ddcb5649a8280ca800075bfd8f151115bba6b3",
        "uploaded_at": "2020-05-05 14:52:54 UTC",
        "custom_id": "Sample",
        "framework":"flutter integration tests"
    }
}
  • test_package Object

    Details of the uploaded test package

    SHOW VALUES
    • test_package_name String

      Filename of the uploaded test package.

    • test_package_url String

      Unique identifier returned upon successful upload of your test package on BrowserStack. This value can be used later to specify the application under test for your Flutter test execution.
      Example: bs://c8ddcb5649a8280ca800075bfd8f151115bba6b3

    • test_package_id String

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

    • uploaded_at String

      Test package upload timestamp.

    • custom_id String

      Custom ID defined for the uploaded test package.
      Example: SampleApp.

    • shareable_id String

      Shareable ID allows other users in your organization to test the test package you uploaded .
      Example: user/SampleApp.

    • expiry String

      By default, an uploaded test package expires in 30 days. Upon expiry, the uploaded test package is deleted from BrowserStack servers and thus can no longer be tested.

Delete a test package

DELETE /app-automate/flutter-integration-tests/v2/ios/test-package/{packageId}

Delete the test package 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/flutter-integration-tests/v2/ios/test-package/e8aa63a101c4a789671688633417795a3fa00770"
  • testpackageId* String

    The test package ID of the uploaded package

Response attributes 200 application/json

Response

{
    "success": {
        "message": "App with url bs://e8aa63a101c4a789671688633417795a3fa00770 was deleted."
    }
}
  • success Object

    This is returned when the app is successfully deleted from BrowserStack servers.

    SHOW VALUES
    • message String

      Confirmation message for package deletion.

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