Test Packages

To test your iOS test package on BrowserStack using Flutter, upload your test package in .zip format 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. Accepted characters are A-Z, a-z, 0-9, ., -, _. All other characters are ignored. Character limit is 100.

Response attributes `200` `application/json`

Response

{
  "test_package_name": "flutter_ios_public.zip",
  "test_package_url": "bs://ab001d58695f23f0ee925ad7e3126015e5846ca8",
  "test_package_id": "ab001d58695f23f0ee925ad7e3126015e5846ca8",
  "uploaded_at": "2023-11-03 06:38:33 UTC",
  "expiry": "2023-12-03 06:38:33 UTC",
  "framework": "flutter integration tests",
  "custom_id": "SampleApp",
  "shareable_id": "sample_user/SampleApp"
}

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.
shareable_id String

Shareable ID allows other users in your organization to test with an flutter test-suite you uploaded .
Example: sample_user/SampleApp

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. Accepted characters are A-Z, a-z, 0-9, ., -, _. All other characters are ignored. Character limit is 100.

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. Accepted characters are A-Z, a-z, 0-9, ., -, _. All other characters are ignored. Character limit is 100.
- 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. Accepted characters are A-Z, a-z, 0-9, ., -, _. All other characters are ignored. Character limit is 100.
- 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.Note that a test package once deleted cannot be recovered.

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.

Did this page help you?

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

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback

Test Packages

Upload the test package

Request parameters

file File

custom_id String

Response attributes 200 application/json

test_package_name String

test_package_url String

test_package_id String

uploaded_at String

expiry String

framework String

shareable_id String

List uploaded test packages

Request parameters

custom_id String

scope String

limit String

Response attributes 200 application/json

test_packages Array

test_package_name String

test_package_url String

test_package_id String

uploaded_at String

custom_id String

shareable_id String

expiry String

Get test package details

Request parameters

test_packageId* String

Response attributes 200 application/json

test_package Object

test_package_name String

test_package_url String

test_package_id String

uploaded_at String

custom_id String

shareable_id String

expiry String

Delete a test package

Request parameters

testpackageId* String

Response attributes 200 application/json

success Object

message String

We're sorry to hear that. Please share your feedback so we can do better

We're continuously improving our docs. We'd love to know what you liked

Response attributes `200` `application/json`

Response attributes `200` `application/json`

test_packageId^* String

Response attributes `200` `application/json`

testpackageId^* String

Response attributes `200` `application/json`