***

title: Integrate Postman with Bitbucket Pipelines
updated: 2024-07-02T00:00:00.000Z
slug: docs/integrations/available-integrations/ci-integrations/bitbucket-pipelines
max-toc-depth: 2
----------------

[Bitbucket Pipelines](https://bitbucket.org/product/features/pipelines) is a continuous integration and continuous delivery (CI/CD) service that's integrated with Bitbucket Cloud. Software development teams can use Bitbucket Pipelines to automatically build, test, and deploy code in Bitbucket.

To set up a Bitbucket Pipelines integration for your API in the Postman API Builder, first create a pipeline in Bitbucket and then configure your API in Postman. After you set up the integration, you can view the status of builds or start a new build, all from within Postman.

## Creating a pipeline in Bitbucket

If you haven't already, create a pipeline in the Bitbucket repository you use for your API. To create a pipeline, add a `bitbucket-pipelines.yml` file in the root of your repository. You define your pipeline in this YAML file. To learn more, see [the Bitbucket Pipelines documentation](https://support.atlassian.com/bitbucket-cloud/docs/get-started-with-bitbucket-pipelines/).

## Configuring a Bitbucket Pipelines integration

1. Open your API by selecting **APIs** in the sidebar. *Each API can be linked to one CI project*.
   <Info class="iconless-callout">
     **Tip:** If you've already authenticated with Bitbucket to connect a Git repo for source control, you can use the same authentication. To automatically create the integration, under **Test and Automation**, select **Connect to Bitbucket Pipelines**.
   </Info>
2. Click **Test and Automation**.
3. Under **Automate**, select **Bitbucket**.
4. You'll be prompted to authorize Postman to access your Bitbucket account. After you grant access, you can close the browser tab and return to Postman.
5. Enter a **Nickname** to help you recognize the integration later.
6. Select the Bitbucket **Workspace** with your API repository.
7. Select the **CI project** used for your API.
8. Click **Connect**.

<img alt="Connect to Bitbucket Pipelines" src="https://assets.postman.com/postman-docs/v10/bitbucket-pipelines-connect-project-v10.jpg" />

## Viewing build status

After you set up a Bitbucket Pipelines integration, information for build jobs is available in Postman. For each build you can view the branch, start time, duration, and status (`Successful` or `Failed`). You can also view the results of collection runs that are [configured in your pipeline using the Postman CLI](#viewing-collection-run-details).

To view build jobs, open an API and click **Test and Automation**. The most recent jobs are listed under the repository name.

Click **View All Builds** to view the full list of build jobs. From here you can take the following actions:

* Use the dropdown lists to filter jobs by branch or build status.
* To open a build in Bitbucket Pipelines, select the build name.
* To start a new build, click **Run Build**. Select or enter the name of the branch to use and click **Run Build**. To cancel a running build, click **Cancel** next to the build.
* To get the latest build status information, click <img alt="Refresh icon" src="https://assets.postman.com/postman-docs/icon-refresh-v9-5.jpg#icon" width="14px" /> **Refresh**.
* To edit or delete the integration, click the more actions icon <img alt="More actions icon" src="https://assets.postman.com/postman-docs/icon-more-actions-v9.jpg#icon" width="16px" />.

<img alt="View all Bitbucket Pipelines builds" src="https://assets.postman.com/postman-docs/v10/collection-runs-v10-2.jpg" />

## Viewing collection run details

Using the Postman CLI, you can run Postman collections with your API tests as part of a Bitbucket pipeline.

To view details for collections that were run as part of a build, first [configure the Postman CLI for Bitbucket Pipelines](#configuring-the-postman-cli-for-bitbucket-pipelines) and then [start a new build](#viewing-build-status). After the build is complete, use the arrows to expand a build and expand a collection to view details about a collection run.

<Info class="iconless-callout">
  Select **View Report** to view a collection run report in the Postman **History**. Learn more about using the [Collection Runner](/docs/collections/running-collections/intro-to-collection-runs/).
</Info>

## Viewing API Governance and API Security rule violations

Using the Postman CLI, you can enforce [Postman API Governance and API Security rules each time the pipeline runs](/docs/api-governance/api-definition/api-definition-warnings/#track-governance-and-security-rule-violations-in-cicd) using the [api lint](/docs/postman-cli/postman-cli-options/#governance-and-security) command ([Enterprise teams only](https://www.postman.com/pricing/)).

To view the results of API Governance and API Security checks that ran as part of the build, first [configure the Postman CLI for Bitbucket Pipelines](#configuring-the-postman-cli-for-bitbucket-pipelines) and then [start a new build](#viewing-build-status). After the build is complete, use the arrows to expand a build and expand an API specification stored in the Postman API Builder to view any rule violations.

<img alt="View API Governance and API Security results" src="https://assets.postman.com/postman-docs/v10/api-governance-and-security-results-v10.jpg" />

## Configuring the Postman CLI for Bitbucket Pipelines

With the help of the Postman CLI and the Postman API, you can run Postman collections with your API tests as part of your Bitbucket pipeline. First generate the Postman CLI configuration code in Postman. Then add the configuration code to the `bitbucket-pipelines.yml` file in your Bitbucket repository.

Each time the pipeline runs, the Postman CLI runs the collections that contain your tests. You can view the results of your tests in Postman. You can also enforce [API Governance and API Security rules](/docs/api-governance/api-definition/api-definition-warnings/#track-governance-and-security-rule-violations-in-cicd) each time the pipeline runs ([Enterprise teams only](https://www.postman.com/pricing/)).

<Info class="iconless-callout">
  Before you begin, make sure you've already [set up an integration](#configuring-a-bitbucket-pipelines-integration) between your API and Bitbucket Pipelines.
</Info>

To generate configuration code for the Postman CLI, do the following:

1. Open your API and click **Test and Automation**.
2. Select the repository, and then select **Configure Postman CLI**.
3. Select a **Collection** to run during pipeline builds. To be available in the list, you must first [add the collection as a test suite](/docs/design-apis/api-builder/testing-an-api/#adding-api-tests) to your API in the Postman API Builder. You can also select an **Environment** to use.
4. (Optional) Select the checkbox to enforce API Governance and API Security rules each time the CI/CD pipeline runs ([Enterprise teams only](https://www.postman.com/pricing/)).
5. Select the **Operating system** for your CI/CD pipeline.
6. Click **Copy Postman CLI Command** to copy the Postman CLI configuration.

<img alt="Generate the Postman CLI configuration" src="https://assets.postman.com/postman-docs/v10/generate-postman-cli-v10-3.jpg" />

To add the Postman CLI configuration to your Bitbucket pipeline, do the following:

1. Edit the `bitbucket-pipelines.yml` file at the root of your Bitbucket repository.
2. Add the Postman CLI configuration you copied from Postman to the `bitbucket-pipelines.yml` file. Then, replace all instances of `$POSTMAN_API_KEY` with a valid [Postman API Key](/docs/developer/postman-api/authentication/#generate-a-postman-api-key).
3. Commit and push the changes to your remote repository. This will automatically start a build in Bitbucket Pipelines.
4. To view the test results in Postman, open your API and click **Test and Automation**. Learn more about [Viewing collection run details](#viewing-collection-run-details).