Documentation

Bitrise

By integrating Bitrise with DX, you can analyze CI/CD pipeline and workflow metrics. Please refer to the API documentation below and our schema explorer to see what data DX imports.

Prerequisites

To connect Bitrise to DX, you need:

a Bitrise workspace API token with access to the apps you want to import
if your Bitrise account has IP restrictions, you need to allowlist DX IP addresses

Setup instructions

Follow the steps below to connect Bitrise to DX.

Step 1

Bitrise does not let you choose granular API scopes for a token. Access is controlled by the token’s workspace role and product access to apps.

Log in to Bitrise, select your workspace, and go to Settings → Security.
Open the API tokens tab, then click + Create token.
On Settings, enter a name and set Workspace role to Viewer, then click Next.
On Product access, grant the token access to the apps you want DX to import, then click Next.
On Save token, copy the token and store it securely. You cannot view the token again after you close the dialog.

Step 2

Navigate to the connections page in DX and select “+ Connection” in the top right.
Enter the credentials you have generated in the previous steps—refer to the information below for errors and troubleshooting.

API reference

The table below lists the specific API endpoints that are used by DX.

Endpoint	Documentation
/v0.1/apps	Link
/v0.1/apps/{appSlug}/pipelines	Link
/v0.1/apps/{appSlug}/pipelines/	Link

Errors

The table below lists potential error codes when adding a connection in DX.

Error	Description
`invalid_credentials`	Your API credentials entered are not valid.
`invalid_permissions`	Your API token does not have sufficient workspace or product access for the apps DX needs.
`no_resources`	DX cannot access any apps in your Bitrise workspace.

When DX verifies a Bitrise connection, it checks that your API token can list apps and read pipelines for them. If your connection is failing, you can test these endpoints directly using the curl commands below to troubleshoot the issue.

Note: Bitrise expects the raw token in the Authorization header—do not prepend Bearer.

Step 1: Test apps access

First, test if your token can list apps. Replace YOUR_API_TOKEN with your Bitrise workspace API token:

curl -H 'Authorization: YOUR_API_TOKEN' \
     -H 'Accept: application/json' \
     'https://api.bitrise.io/v0.1/apps?limit=1'

Expected result: Returns a JSON object with a data array containing at least one app.
If you get 401 Unauthorized, the token is invalid or expired. If data is empty, the token has no accessible apps.

Step 2: Test pipelines access

Pick an app_slug from the previous response and confirm pipelines can be read. Replace YOUR_APP_SLUG with that value:

curl -H 'Authorization: YOUR_API_TOKEN' \
     -H 'Accept: application/json' \
     'https://api.bitrise.io/v0.1/apps/YOUR_APP_SLUG/pipelines?limit=1'

Expected result: Returns a JSON object with a data array of pipeline runs (may be empty if the app has never been built).
If you get 403 Forbidden, the token can see the app but not its pipelines.