Corporate logotype
  • Go to Support
  • Book a demo
Corporate logotype
  • Getting started
    • Migrating to Bitrise
      • Migrating from Jenkins to Bitrise
    • Signing up for Bitrise
      • Creating your first Workspace
      • Adding your first app
      • Getting started with iOS apps
        • Getting started with Android apps
          • Getting started with React Native apps
            • Getting started with Flutter apps
              • Getting started with Ionic/Cordova apps
                • Getting started with Expo apps
                  • Getting started with MacOS apps
                  • Infrastructure
                    • Build machines
                      • Configuring network access for Bitrise build machines
                      • Storage space on build machines
                      • Freeing up storage space on build machines
                      • Customizing build machines
                    • Build stacks
                      • Stack update policy
                      • Stack deprecation and removal policy
                      • Preinstalled tools on Bitrise stacks
                      • The Android/Linux/Docker environment
                      • Managing Java versions
                    • Code security
                      • Customizable enterprise build platforms
                        • Using your own Docker image
                          • Running your build locally in Docker
                          • Accounts
                            • Connecting to services
                              • The service credential user
                              • Connecting your GitHub/GitLab/Bitbucket account to Bitrise
                              • Connecting self-hosted GitLab instances
                              • Apple services connection
                              • Connecting to an Apple service with API key
                              • Connecting to an Apple service with Apple ID
                              • Connecting to an Apple Service with Step inputs
                              • Steps requiring Apple authentication
                            • SAML SSO in Bitrise
                              • Setting up Google SSO for Bitrise
                              • Setting up AD FS SSO for Bitrise
                              • Setting up Azure AD SSO for Bitrise
                              • Setting up Auth0 SSO for Bitrise
                              • Setting up Idaptive SAML SSO for Bitrise
                              • Setting up Okta SSO for Bitrise
                              • Setting up Ping Identity SSO for Bitrise
                              • Setting up OneLogin SSO for Bitrise
                            • Editing your profile settings
                              • Resetting your password
                              • Two-factor authentication
                                • Personal access tokens
                                  • Deleting your Bitrise account
                                • Workspaces
                                  • Creating Workspaces
                                  • Workspace billing and invoicing
                                    • Adding other users to Workspaces
                                      • Changing the owners of a Workspace
                                      • Workspace FAQ
                                    • Apps
                                      • Webhooks
                                        • Adding incoming webhooks
                                        • Adding a GitHub webhook
                                        • Adding a Gitlab webhook
                                        • Adding a Bitbucket webhook
                                        • Adding a Gogs webhook
                                        • Adding a Slack webhook
                                        • Adding a Visual Studio webhook
                                        • Adding an Assembla webhook
                                        • Adding a Deveo webhook
                                        • Adding outgoing webhooks
                                      • Configuring the repository URL and default branch
                                        • Configuring SSH keys
                                        • Adding team members to an app
                                          • User roles on app teams
                                            • Changing the owner of an app
                                              • Enabling the Bitrise Support user for your app
                                              • Apps with submodules or private repo dependencies
                                                • Public apps
                                                • Creating white label app versions
                                                • Steps and Workflows
                                                  • Steps
                                                    • Adding Steps to a Workflow
                                                    • Step versioning
                                                    • Step inputs
                                                    • Skipping Steps
                                                    • Enabling or disabling a Step conditionally
                                                    • Setting a time limit for Steps
                                                  • Developing your own Bitrise Step
                                                    • Developing a new Step
                                                    • Sharing Steps with all Bitrise users
                                                    • Verified Steps
                                                    • Creating your own Bitrise project scanner
                                                  • Workflows
                                                    • Default Workflows
                                                    • Creating a Workflow
                                                    • Managing Workflows
                                                    • Copying Workflows from one app to another
                                                  • Workflow recipes for Android apps
                                                    • (Android) Deploy to Visual Studio App Center
                                                    • (Android) Deploy to Firebase App Distribution
                                                    • (Android) Deploy to Google Play (Internal, Alpha, Beta, Production)
                                                    • (Android) Deploy to Bitrise.io
                                                    • (Android) Example CI Workflow
                                                    • (Android) Example nightly Workflow
                                                    • (Android) Example pull request Workflow
                                                    • (Android) Run instrumentation tests on virtual devices
                                                    • (Android) Example release Workflow
                                                    • (Android) Run Lint
                                                    • Turn on Gradle build profiling
                                                    • (Android) Run unit tests
                                                    • (Android) Run tests using the emulator
                                                  • Workflow recipes for iOS apps
                                                    • (iOS) Deploy to Visual Studio App Center
                                                    • (iOS) Cache CocoaPods dependencies
                                                    • (iOS) Deploy to App Store Connect / TestFlight
                                                    • (iOS) Example CI Workflow
                                                    • (iOS) Deploy to bitrise.io
                                                    • (iOS) Example pull request Workflow
                                                    • (iOS) Deploy to Firebase App Distribution
                                                    • (iOS) Example nightly Workflow
                                                    • (iOS) Run tests on a physical device
                                                    • (iOS) Run tests on a simulator
                                                    • (iOS) Install CocoaPods dependencies
                                                    • (iOS) Install Carthage dependencies
                                                    • (iOS) Example release Workflow
                                                  • Workflow recipes for cross-platform apps
                                                    • (React Native) Cache dependencies (node_modules)
                                                    • (React Native) Expo: Build using Turtle CLI
                                                    • (React Native) Run tests
                                                    • (React Native) Install dependencies
                                                    • (Flutter) Run tests
                                                    • (Flutter) Install Flutter SDK
                                                    • (Flutter) Run Dart Analyzer
                                                  • Generic Workflow recipes
                                                    • (iOS/Android) Send build status to Slack
                                                    • Cloning a Git repository
                                                    • Shallow clone a Git repository
                                                    • Example Gitflow release branch Workflow
                                                    • (iOS/Android) Send QR code to Slack
                                                    • Start builds from a parent Workflow
                                                    • Optimizing cache efficiency for pull request builds
                                                    • GitHub pull request: send the build QR code
                                                • Builds
                                                  • Configuring build settings
                                                    • Setting the stack for your builds
                                                    • Managing an app's bitrise.yml file
                                                    • Editing the app's bitrise.yml file
                                                    • Accessing a build's bitrise.yml file
                                                    • Selective builds
                                                    • Rolling builds
                                                    • Configuring email notifications
                                                    • Configuring Slack integration
                                                    • Setting your Git credentials on build machines
                                                    • Reporting the build status to your Git hosting provider
                                                  • Starting builds
                                                    • Starting builds manually
                                                    • Triggering builds automatically
                                                    • Scheduling builds
                                                    • Approving pull request builds
                                                    • Using the Trigger Map to trigger builds
                                                    • Starting parallel builds with a single trigger
                                                    • Skipping a given commit or pull request
                                                  • Caching
                                                    • Using caching in your builds
                                                    • Caching Cocoapods
                                                    • Caching Gradle
                                                    • Caching Maven
                                                    • Caching Ruby Gems
                                                    • Caching Homebrew installers
                                                  • Managing build files
                                                    • Uploading files for your builds
                                                    • Using files in your builds
                                                    • Using encrypted files in your builds
                                                    • Build artifacts online
                                                  • Environment Variables
                                                    • Secrets
                                                      • Build statuses
                                                      • Installing tools during a build
                                                        • Connecting to a VPN during a build
                                                          • Finding a specific build
                                                          • Build numbering and app versioning
                                                            • Build data and troubleshooting
                                                              • Build logs
                                                              • Remote access
                                                              • Debugging your build on your own machine
                                                              • Bitrise Checks on GitHub
                                                              • Monitoring your builds with Meercode
                                                              • Checking build details
                                                          • Code signing
                                                            • Android code signing
                                                              • Android code signing using the Android Sign Step
                                                              • Android code signing with Android Studio
                                                              • Android code signing in Gradle
                                                              • Downloading a keystore file
                                                            • iOS code signing
                                                              • Collecting and exporting code signing files with codesigndoc
                                                              • iOS code signing with automatic provisioning
                                                              • Managing iOS code signing files - manual provisioning
                                                              • Creating a signed IPA for Xcode projects
                                                              • Signing an IPA with multiple code signing identities
                                                              • iOS code signing for Ionic and Cordova projects
                                                              • Protecting your code signing files
                                                              • Generating iOS code signing files
                                                              • Exporting iOS code signing files manually
                                                              • Troubleshooting iOS code signing
                                                          • Testing
                                                            • Test Reports
                                                              • Exporting to Test Reports from any Step
                                                                • Running Xcode tests
                                                                  • Installing an ipa file from the public install page
                                                                    • Registering a test device
                                                                      • Device testing for iOS
                                                                        • Android unit tests
                                                                          • Device testing for Android
                                                                            • Running tests in the Visual Studio App Center
                                                                            • Running Detox tests on Bitrise
                                                                            • Deploying
                                                                              • Android deployment
                                                                                • Deploying Android apps to Bitrise and Google Play
                                                                                • Deploying apps to Huawei AppGallery
                                                                                • Generate and deploy multiple flavor APKs in a single workflow
                                                                                • Generating and deploying Android app bundles
                                                                                • Exporting a universal APK from an AAB
                                                                              • iOS deployment
                                                                                • Deploying an iOS app to Bitrise.io
                                                                                • Deploying an iOS app for external testing
                                                                                • Deploying an iOS app to iTunes Connect
                                                                                • Deploying an iOS app for simulators
                                                                              • Bitrise OTA app deployment
                                                                                • Deploying with Ship
                                                                                  • Getting started with Ship
                                                                                  • Configuring an app for publishing with Ship
                                                                                  • Installing an app on a test device with Ship
                                                                                  • Publishing an app to a store with Ship
                                                                                  • Using Ship for apps built with cross-platform frameworks
                                                                                  • App details in Ship
                                                                                  • Ship notifications
                                                                                • Deploying apps to Applivery
                                                                                  • Deploying apps to DeployGate from Bitrise
                                                                                  • Deploying your app to Appaloosa
                                                                                  • Deploying to TestFairy with Bitrise
                                                                                • Build Insights
                                                                                  • Getting started with Insights
                                                                                    • Available metrics in Insights
                                                                                      • Test stats in Build Insights
                                                                                      • Bitrise CLI
                                                                                        • Installing and updating the Bitrise CLI
                                                                                          • Adding a new app from a CLI
                                                                                          • Initializing a Bitrise project locally
                                                                                          • Installing and upgrading the offline Workflow Editor
                                                                                            • Running your first local build with the CLI
                                                                                            • Managing Secrets locally
                                                                                          • API
                                                                                            • Authenticating with the Bitrise API
                                                                                            • Pagination of API calls
                                                                                            • Adding and managing apps
                                                                                              • Triggering and aborting builds
                                                                                                • Incoming and outgoing webhooks
                                                                                                  • Managing iOS code signing files
                                                                                                    • Managing files in Generic File Storage
                                                                                                      • Managing build artifacts
                                                                                                        • API reference
                                                                                                      • References
                                                                                                        • Basics of bitrise.yml
                                                                                                        • Customizing the bitrise.yml config
                                                                                                        • Workflow reference
                                                                                                        • Steps reference
                                                                                                          • Step reference/ID format
                                                                                                          • Step data in the bitrise.yml file
                                                                                                          • Step properties
                                                                                                          • Step inputs reference
                                                                                                          • Step outputs reference
                                                                                                        • Available environment variables
                                                                                                        • Bitrise tools
                                                                                                      • Go to Support
                                                                                                      • Book a demo
                                                                                                      print
                                                                                                      • Prev
                                                                                                      • Next
                                                                                                      • Welcome to Bitrise documentation!
                                                                                                      • API
                                                                                                      • Managing build artifacts

                                                                                                      Managing build artifacts

                                                                                                      If you add the Deploy to bitrise.io step to your Workflow, once the build has run, you can access the build artifacts in the Artifacts tab.

                                                                                                      You can also manage the generated artifacts with the Bitrise API.

                                                                                                      Table 1. Endpoints related to managing build artifacts with the API

                                                                                                      Endpoint

                                                                                                      Function

                                                                                                      Required role on the app's team

                                                                                                      GET/apps/{app-slug}/builds/{build-slug}/artifacts

                                                                                                      Listing build artifacts

                                                                                                      Any

                                                                                                      GET/apps/{app-slug}/builds/{build-slug}/artifacts/{artifact-slug}

                                                                                                      Retrieving data of a specific build artifact

                                                                                                      Any

                                                                                                      PATCH/apps/{app-slug}/builds/{build-slug}/artifacts/{artifact-slug}

                                                                                                      Updating a build artifact

                                                                                                      Owner, Admin, or Developer

                                                                                                      DELETE/apps/{app-slug}/builds/{build-slug}/artifacts/{artifact-slug}

                                                                                                      Deleting a build artifact

                                                                                                      Owner, Admin, or Developer


                                                                                                      Listing build artifacts

                                                                                                      Required role

                                                                                                      You must have a tester/QA, developer, admin, or owner role on the app's team to list build artifacts using the API.

                                                                                                      For a complete list of user roles and role cheatsheets, check User roles on app teams.

                                                                                                      To be able to use build artifact endpoints, you have to first list all artifacts that belong to an app’s build. The response will list all artifacts along with their slug which you will need later.

                                                                                                      The required parameters are:

                                                                                                      • app slug

                                                                                                      • build slug

                                                                                                      You can use the generated build artifact slug/s from the response output with other build artifact endpoints where the build artifact slug is a required parameter.

                                                                                                      Example 1. Listing the artifacts of an app

                                                                                                      Request:

                                                                                                      curl -X GET "https://api.bitrise.io/v0.1/apps/87a5991e180d91a9/builds/b234f959745082e0/artifacts" -H "accept: application/json" -H "Authorization: THE-ACCESS-TOKEN"

                                                                                                      Response:

                                                                                                      {
                                                                                                        "data": [
                                                                                                          {
                                                                                                            "title": "another_app-debug.apk",
                                                                                                            "artifact_type": "android-apk",
                                                                                                            "is_public_page_enabled": true,
                                                                                                            "slug": "92e0b6ecae87b832",
                                                                                                            "file_size_bytes": 1574799
                                                                                                          },
                                                                                                          {
                                                                                                            "title": "app-debug.apk",
                                                                                                            "artifact_type": "android-apk",
                                                                                                            "is_public_page_enabled": true,
                                                                                                            "slug": "54ae701761c4f956",
                                                                                                            "file_size_bytes": 1574793
                                                                                                          }
                                                                                                        ],
                                                                                                        "paging": {
                                                                                                          "total_item_count": 2,
                                                                                                          "page_item_limit": 50
                                                                                                        }
                                                                                                      }

                                                                                                      Retrieving a specific build artifact's data

                                                                                                      Required role

                                                                                                      You must have a tester/QA, developer, admin, or owner role on the app's team to retrive a specific build's artifact data using the API.

                                                                                                      For a complete list of user roles and role cheatsheets, check User roles on app teams.

                                                                                                      You can retrieve detailed data of a specific build's artifacts with the artifacts endpoint. The response shows the filename, the artifact type, the download URL, and the file size.

                                                                                                      The required parameters are:

                                                                                                      • app slug

                                                                                                      • build slug

                                                                                                      • artifact slug

                                                                                                      Example 1. Retrieving the data of a specific artifact

                                                                                                      Request:

                                                                                                      curl -X GET "https://api.bitrise.io/v0.1/apps/87a5991e180d91a9/builds/b234f959745082e0/artifacts/92e0b6ecae87b832" -H "accept: application/json" -H "Authorization: THE-ACCESS-TOKEN"

                                                                                                      Response:

                                                                                                      {
                                                                                                        "data": {
                                                                                                          "title": "another_app-debug.apk",
                                                                                                          "artifact_type": "android-apk",
                                                                                                          "expiring_download_url": "https://bitrise-prod-build-storage.s3.amazonaws.com/builds/b234f959745082e0/artifacts/7626902/another_app-debug.apk?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAIV2YZWMVCNWNR2HA%2F20190426%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20190426T131627Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=9f1af26787f34b5cf0cbc18b2372313607b1e3c0203a9ce7e42da884a6ddf70f",
                                                                                                          "is_public_page_enabled": true,
                                                                                                          "slug": "92e0b6ecae87b832",
                                                                                                          "public_install_page_url": "https://www.bitrise.io/artifact/7626902/p/8e5b2c62abe28fecef09b271de767920",
                                                                                                          "file_size_bytes": 1574799
                                                                                                        }
                                                                                                      }

                                                                                                      By default, the value of the is_public_page_enabled input is set to true. This way the public_install_page_url becomes available and you can view some basic information about the artifact via this URL. You can also download the artifact using the download URL from the response output.


                                                                                                      Disabling the public install page of an artifact

                                                                                                      Required role

                                                                                                      You must have a developer, admin, or owner role on the app's team to disable the public install page of an artifact using the API.

                                                                                                      For a complete list of user roles and role cheatsheets, check User roles on app teams.

                                                                                                      You can update the is_public_page_enabled parameter of your APK and IPA files. Please note this parameter’s value is set to true by default so you can only disable it with this endpoint.

                                                                                                      The required parameters are:

                                                                                                      • app slug

                                                                                                      • build slug

                                                                                                      • artifact slug

                                                                                                      Example 1. Disabling the public install page for an APK file

                                                                                                      Request:

                                                                                                      curl -X PATCH "https://api.bitrise.io/v0.1/apps/87a5991e180d91a9/builds/b234f959745082e0/artifacts/54ae701761c4f956" -H "accept: application/json" -H "Authorization: THE-ACCESS-TOKEN" -H "Content-Type: application/json" -d "{ \"is_public_page_enabled\": false}"
                                                                                                      

                                                                                                      Response:

                                                                                                      {
                                                                                                        "data": {
                                                                                                          "title": "app-debug.apk",
                                                                                                          "artifact_type": "android-apk",
                                                                                                          "expiring_download_url": "https://bitrise-prod-build-storage.s3.amazonaws.com/builds/b234f959745082e0/artifacts/7626904/app-debug.apk?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAIV2YZWMVCNWNR2HA%2F20190503%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20190503T082800Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=7251fcbc0574ffac60b3f1d4a8c398658e49f0b86fb3cfec1500bde125738abc",
                                                                                                          "is_public_page_enabled": false,
                                                                                                          "slug": "54ae701761c4f956",
                                                                                                          "public_install_page_url": "",
                                                                                                          "file_size_bytes": 1574793
                                                                                                        }
                                                                                                      }

                                                                                                      If you check the build’s Artifacts tab, you will see that the Public install page toggle is disabled.


                                                                                                      Deleting a build artifact

                                                                                                      Required role

                                                                                                      You must have a developer, admin, or owner role on the app's team to delete a build artifact using the API.

                                                                                                      For a complete list of user roles and role cheatsheets, check User roles on app teams.

                                                                                                      You can delete an app’s specific build artifact.

                                                                                                      The required parameters are:

                                                                                                      • app slug

                                                                                                      • build slug

                                                                                                      • artifact slug

                                                                                                      Example 1. Deleting an APK file

                                                                                                      Request:

                                                                                                      curl -X DELETE "https://api.bitrise.io/v0.1/apps/87a5991e180d91a9/builds/b234f959745082e0/artifacts/54ae701761c4f956" -H "accept: application/json" -H "Authorization: THE-ACCESS-TOKEN"

                                                                                                      Response:

                                                                                                      {
                                                                                                        "data": {
                                                                                                          "title": "app-debug.apk",
                                                                                                          "artifact_type": "android-apk",
                                                                                                          "expiring_download_url": null,
                                                                                                          "is_public_page_enabled": true,
                                                                                                          "slug": "54ae701761c4f956",
                                                                                                          "public_install_page_url": "",
                                                                                                          "file_size_bytes": 1574793
                                                                                                        }
                                                                                                      }
                                                                                                      

                                                                                                      In this section:
                                                                                                      See also:
                                                                                                      • Connecting to a VPN during a build
                                                                                                      • Managing build artifacts
                                                                                                      • Listing build artifacts
                                                                                                      • Retrieving a specific build artifact's data
                                                                                                      • Disabling the public install page of an artifact
                                                                                                      • Deleting a build artifact

                                                                                                      Search results

                                                                                                        No results found

                                                                                                        Was this helpful?

                                                                                                        Would you like to provide feedback? Just click here to suggest edits.

                                                                                                        • Prev
                                                                                                        • Next
                                                                                                        © 2022
                                                                                                        Publication date: