docs/Configuration/BitBucket/index.html - devlake-website - Git at Google

 <!doctype html>
 <html lang="en-GB" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-Configuration/BitBucket">
 <head>
 <meta charset="UTF-8">
 <meta name="viewport" content="width=device-width,initial-scale=1">
 <meta name="generator" content="Docusaurus v2.0.0-rc.1">
 <link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Apache DevLake - Open-Source Dev Data Platform for Productivity RSS Feed">
 <link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Apache DevLake - Open-Source Dev Data Platform for Productivity Atom Feed"><title data-rh="true">Bitbucket Cloud | Apache DevLake - Open-Source Dev Data Platform for Productivity</title><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://devlake.apache.org/docs/Configuration/BitBucket"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Engineering Productivity, Open-Source Engineering, Open-Source Integration Tools, Data Integrates Platform, Open-Source Dev Platform, Open-Source Data Integrates, DevOps Tools Integrates, Open-Source DevOps Tools"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Bitbucket Cloud | Apache DevLake - Open-Source Dev Data Platform for Productivity"><meta data-rh="true" name="description" content="Config UI instruction for Bitbucket(Cloud)"><meta data-rh="true" property="og:description" content="Config UI instruction for Bitbucket(Cloud)"><link data-rh="true" rel="icon" href="/img/logo.svg"><link data-rh="true" rel="canonical" href="https://devlake.apache.org/docs/Configuration/BitBucket"><link data-rh="true" rel="alternate" href="https://devlake.apache.org/docs/Configuration/BitBucket" hreflang="en-GB"><link data-rh="true" rel="alternate" href="https://devlake.apache.org/zh/docs/Configuration/BitBucket" hreflang="zh"><link data-rh="true" rel="alternate" href="https://devlake.apache.org/docs/Configuration/BitBucket" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.0a4edf75.css">
 <link rel="preload" href="/assets/js/runtime~main.566cb87a.js" as="script">
 <link rel="preload" href="/assets/js/main.c5c21f25.js" as="script">
 </head>
 <body class="navigation-with-keyboard">
 <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
 <div role="region"><a href="#" class="skipToContent_fXgn">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="apache devlake" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/logo.svg" alt="apache devlake" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Apache DevLake</b></a></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Docs</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/Overview/Introduction">Next</a></li><li><a class="dropdown__link" href="/docs/v1.0/Overview/Introduction">v1.0 (Stable)</a></li><li><a class="dropdown__link" href="/docs/v0.21/Overview/Introduction">v0.21</a></li><li><a class="dropdown__link" href="/docs/v0.20/Overview/Introduction">v0.20</a></li><li><a class="dropdown__link" href="/docs/v0.19/Overview/Introduction">v0.19</a></li><li><a class="dropdown__link" href="/docs/v0.18/Overview/Introduction">v0.18</a></li><li><a class="dropdown__link" href="/docs/v0.17/Overview/Introduction">v0.17</a></li><li><a class="dropdown__link" href="/docs/v0.16/Overview/Introduction">v0.16</a></li><li><a class="dropdown__link" href="/docs/v0.15/Overview/Introduction">v0.15</a></li></ul></div><a class="navbar__item navbar__link" href="/livedemo/EngineeringLeads/DORA">Use Cases</a><a class="navbar__item navbar__link" href="/community/">Community</a><a class="navbar__item navbar__link" href="/team">Team</a><a class="navbar__item navbar__link" href="/blogOverview">Blog</a><a href="https://github.com/apache/devlake" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub</a><a class="navbar__item navbar__link" href="/download">Download</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">ASF</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Foundation</a></li><li><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">License</a></li><li><a href="https://www.apache.org/events/current-event" target="_blank" rel="noopener noreferrer" class="dropdown__link">Events</a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Security</a></li><li><a href="https://privacy.apache.org/policies/privacy-policy-public.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Privacy</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship</a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks</a></li></ul></div><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"><div class="navbar__search searchBarContainer_NW3z"><input placeholder="Search" aria-label="Search" class="navbar__search-input"><div class="loadingRing_RJI3 searchBarLoadingRing_YnHq"><div></div><div></div><div></div><div></div></div></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebar_njMd"><nav class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/Overview">Overview</a><button aria-label="Toggle the collapsible sidebar category &#x27;Overview&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/GettingStarted">Getting Started</a><button aria-label="Toggle the collapsible sidebar category &#x27;Getting Started&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/docs/Config UI">Config UI</a><button aria-label="Toggle the collapsible sidebar category &#x27;Config UI&#x27;" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/Tutorial">Tutorial</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/HowToOrganizeDevlakeProjects">How to Organize DevLake Projects</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/AzureDevOps">Azure DevOps</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/Configuration/BitBucket">Bitbucket Cloud</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/BitBucketServer">Bitbucket Server/Data Center</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/CircleCI">CircleCI</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/GitHub">GitHub</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/GitLab">GitLab</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/Opsgenie">Opsgenie</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/Jenkins">Jenkins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/Jira">Jira</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/PagerDuty">PagerDuty</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/SonarQube">SonarQube Server</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/Tapd">TAPD</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/Teambition">Teambition(WIP)</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/webhook">Webhooks</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/Zentao">Zentao</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/AdvancedMode">Blueprint Advanced Mode</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/APIKeys">API Keys</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/Configuration/TeamConfiguration">Team Configuration</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/Configuration/Dashboards/AccessControl">Dashboard Configuration</a></div></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/DORA">DORA</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/Metrics">Metrics</a><button aria-label="Toggle the collapsible sidebar category &#x27;Metrics&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/DataModels">Data Models</a><button aria-label="Toggle the collapsible sidebar category &#x27;Data Models&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/DeveloperManuals">Developer Manuals</a><button aria-label="Toggle the collapsible sidebar category &#x27;Developer Manuals&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/Plugins">Plugins</a><button aria-label="Toggle the collapsible sidebar category &#x27;Plugins&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/Troubleshooting">Troubleshooting</a><button aria-label="Toggle the collapsible sidebar category &#x27;Troubleshooting&#x27;" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_OVgt"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/docs/Config UI"><span itemprop="name">Config UI</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Bitbucket Cloud</span><meta itemprop="position" content="2"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: Next</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Bitbucket Cloud</h1></header><p>Visit Config UI at <code>http://localhost:4000</code> and go to the <code>Connections</code> page.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="step-1---add-data-connections">Step 1 - Add Data Connections<a class="hash-link" href="#step-1---add-data-connections" title="Direct link to heading"></a></h2><p><img loading="lazy" alt="Bitbucket connection form showing authentication method selection with API Token and App Password options" src="/assets/images/bitbucket-add-data-connections-23c4a222ecfb5c77e0835b0b579b3779.png" width="1308" height="1376" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="step-11---authentication">Step 1.1 - Authentication<a class="hash-link" href="#step-11---authentication" title="Direct link to heading"></a></h3><h4 class="anchor anchorWithStickyNavbar_LWe7" id="connection-name">Connection Name<a class="hash-link" href="#connection-name" title="Direct link to heading"></a></h4><p>Give your connection a unique name to help you identify it in the future.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-url">Endpoint URL<a class="hash-link" href="#endpoint-url" title="Direct link to heading"></a></h4><p>For Bitbucket Cloud, you do not need to enter the REST API endpoint URL, which is always <code>https://api.bitbucket.org/2.0/</code>.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="authentication-method">Authentication Method<a class="hash-link" href="#authentication-method" title="Direct link to heading"></a></h4><div class="theme-admonition theme-admonition-warning alert alert--danger admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z"></path></svg></span>App Password Deprecation</div><div class="admonitionContent_S0QG"><p>Bitbucket is deprecating App passwords in favor of API tokens:</p><ul><li><strong>September 9, 2025</strong>: Creation of new App passwords will be discontinued</li><li><strong>June 9, 2026</strong>: All existing App passwords will be deactivated</li></ul><p><strong>Please use API tokens for all new connections.</strong> Existing connections using App passwords should be migrated to API tokens before June 9, 2026.</p></div></div><p>You can choose between two authentication methods:</p><h5 class="anchor anchorWithStickyNavbar_LWe7" id="api-token-recommended">API Token (Recommended)<a class="hash-link" href="#api-token-recommended" title="Direct link to heading"></a></h5><p>API tokens are the recommended authentication method for Bitbucket Cloud. Learn about <a href="https://support.atlassian.com/bitbucket-cloud/docs/create-an-api-token/" target="_blank" rel="noopener noreferrer">how to create a Bitbucket API token</a>.</p><p><strong>Steps to create an API token:</strong></p><ol><li>Sign in at <a href="https://id.atlassian.com/manage-profile/security/api-tokens" target="_blank" rel="noopener noreferrer">https://id.atlassian.com/manage-profile/security/api-tokens</a>.</li><li>Select <strong>Create API token with scopes</strong>.</li><li>Give the API token a name and an expiry date (ex: 365 days), then select <strong>Next</strong>.</li><li>Select <strong>Bitbucket</strong> as the app and select <strong>Next</strong>.</li><li>Select the required scopes (see below) and select <strong>Next</strong>.</li><li>Review your token and select <strong>Create token</strong>.</li><li><strong>Copy the generated API token immediately</strong> - it&#x27;s only displayed once and can&#x27;t be retrieved later.</li></ol><p>For detailed instructions, refer to <a href="https://support.atlassian.com/bitbucket-cloud/docs/create-an-api-token/" target="_blank" rel="noopener noreferrer">Atlassian&#x27;s API token documentation</a>.</p><p><strong>Required Scopes:</strong></p><p>The following scopes are <strong>required</strong> to collect data from Bitbucket repositories:</p><ul><li><code>read:account</code> - Required to view users profiles</li><li><code>read:issue:bitbucket</code> - View your issues</li><li><code>read:pipeline:bitbucket</code> - View your pipelines</li><li><code>read:project:bitbucket</code> - View your projects</li><li><code>read:pullrequest:bitbucket</code> - View your pull requests</li><li><code>read:repository:bitbucket</code> - View your repositories</li><li><code>read:runner:bitbucket</code> - View your workspaces/repositories&#x27; runners</li><li><code>read:user:bitbucket</code> - View user info (required for connection test)</li><li><code>read:workspace:bitbucket</code> - View your workspaces</li></ul><p><img loading="lazy" alt="Bitbucket API Token Scopes Selection Interface" src="/assets/images/bitbucket-api-token-scope-selection-interface-17e54fa0dc8b45b634ef575d6d2d3da2.png" width="1636" height="1076" class="img_ev3q"></p><h5 class="anchor anchorWithStickyNavbar_LWe7" id="app-password-deprecated">App Password (Deprecated)<a class="hash-link" href="#app-password-deprecated" title="Direct link to heading"></a></h5><div class="theme-admonition theme-admonition-caution alert alert--warning admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>Deprecated</div><div class="admonitionContent_S0QG"><p>App passwords are deprecated and should only be used for existing connections. For new connections, please use API tokens instead.</p></div></div><p>If you&#x27;re using an existing App password, learn about <a href="https://support.atlassian.com/bitbucket-cloud/docs/create-an-app-password/" target="_blank" rel="noopener noreferrer">how to create a Bitbucket app password</a>.</p><p><strong>Required Permissions:</strong></p><ul><li>Account:Read</li><li>Workspace membership:Read</li><li>Projects:Read</li><li>Repositories:Read</li><li>Pull requests:Read</li><li>Issues:Read</li><li>Pipelines:Read</li><li>Runners:Read</li></ul><p><img loading="lazy" alt="Bitbucket App Password Permissions" src="/assets/images/bitbucket-app-password-permissions-2b87fad376a9ab4a5e4f52b4352d38f1.jpeg" width="1212" height="830" class="img_ev3q"></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="proxy-url-optional">Proxy URL (Optional)<a class="hash-link" href="#proxy-url-optional" title="Direct link to heading"></a></h4><p>If you are behind a corporate firewall or VPN you may need to utilize a proxy server. Enter a valid proxy server address on your network, e.g. <code>http://your-proxy-server.com:1080</code></p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="fixed-rate-limit-optional">Fixed Rate Limit (Optional)<a class="hash-link" href="#fixed-rate-limit-optional" title="Direct link to heading"></a></h4><p>DevLake uses a dynamic rate limit to collect Bitbucket data. You can adjust the rate limit if you want to increase or lower the speed.</p><p>The maximum rate limit for different entities in Bitbucket(Cloud) <a href="https://support.atlassian.com/bitbucket-cloud/docs/api-request-limits/" target="_blank" rel="noopener noreferrer">varies from 1,000 - 60,000 requests/hour</a>. The rate limit to access repository data is 1,000 requests/hour, but we find it can still run when we input a value that exceeds 1,000. You can try using a larger rate limit if you have large repositories.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="test-and-save-connection">Test and Save Connection<a class="hash-link" href="#test-and-save-connection" title="Direct link to heading"></a></h4><p>Click <code>Test Connection</code>, if the connection is successful, click <code>Save Connection</code> to add the connection.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="migrating-from-app-password-to-api-token">Migrating from App Password to API Token<a class="hash-link" href="#migrating-from-app-password-to-api-token" title="Direct link to heading"></a></h4><p>If you have an existing connection using an App password and want to migrate to an API token:</p><ol><li><strong>Create an API token</strong> in Bitbucket (see instructions above)</li><li><strong>Edit your existing connection</strong> in DevLake</li><li><strong>Change the Authentication Method</strong> from &quot;App Password&quot; to &quot;API Token&quot;</li><li><strong>Enter your API token</strong> in the token field</li><li><strong>Test the connection</strong> to verify it works</li><li><strong>Save the connection</strong></li></ol><p>Your data collection will continue without interruption, and you&#x27;ll be ready for the App password deprecation in 2026.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="step-12---add-data-scopes">Step 1.2 - Add Data Scopes<a class="hash-link" href="#step-12---add-data-scopes" title="Direct link to heading"></a></h3><p>Choose the Bitbucket repositories you wish to collect either by finding them in the miller column, or searching. You can only add public repositories through the search box.</p><p><img loading="lazy" alt="Bitbucket - Add Data Scopes" src="/assets/images/bitbucket-add-data-scopes-1532816de790c625cbed55da42ca0f26.png" width="891" height="646" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="step-13---add-scope-config-optional">Step 1.3 - Add Scope Config (Optional)<a class="hash-link" href="#step-13---add-scope-config-optional" title="Direct link to heading"></a></h3><h4 class="anchor anchorWithStickyNavbar_LWe7" id="entities">Entities<a class="hash-link" href="#entities" title="Direct link to heading"></a></h4><p>The entities of which domain you wish to collect: Usually, you don&#x27;t
 have to modify this part. However, if you don&#x27;t want to collect certain
 Bitbucket entities, you can unselect some entities to accelerate the
 collection speed.</p><ul><li>Issue Tracking: Bitbucket issues, issue comments, etc.</li><li>Source Code Management: Bitbucket repos, refs, commits, etc.</li><li>Code Review: Bitbucket PRs, PR comments, etc.</li><li>CI/CD: Bitbucket Pipelines, Bitbucket Deployments, etc.</li><li>Cross Domain: Bitbucket users, etc.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="transformations">Transformations<a class="hash-link" href="#transformations" title="Direct link to heading"></a></h4><p>The transformations on the Bitbucket data you are going to collect.</p><ul><li>The details of the transformations will be explained below.</li><li>Without adding transformation rules, you can still view the &#x27;Bitbucket&#x27; dashboard. However, if you want to view more pre-built dashboards, finish the transformations required.</li><li>Each Bitbucket repo has at most ONE set of transformations.</li></ul><h6 class="anchor anchorWithStickyNavbar_LWe7" id="issue-tracking--issue-status-mapping">Issue Tracking &gt; Issue Status Mapping<a class="hash-link" href="#issue-tracking--issue-status-mapping" title="Direct link to heading"></a></h6><p><img loading="lazy" alt="Bitbucket Issue Status Mapping" src="/assets/images/bitbucket-issue-status-mapping-8df3f1c6926a744813db6d85163cf511.png" width="853" height="178" class="img_ev3q"></p><p>The given settings transformed the Bitbucket issue statuses to the issue statuses used by DevLake, enabling you to measure metrics like the Issue Delivery Rate on the pre-built dashboards, as DevLake understands your definition of when an issue is considered as completed (status = &#x27;DONE&#x27;).</p><ul><li>TODO: The issues that are planned but have not been worked on yet</li><li>IN-PROGRESS: The issues that are work-in-progress</li><li>DONE: The issues that are completed</li><li>OTHER: Other issues statuses that do not belong to the three statuses above</li></ul><p>The original status will be saved in the column <code>original_status</code> of the table &#x27;issues&#x27;, and the new status will be saved in the column <code>status</code> of the same table.</p><h6 class="anchor anchorWithStickyNavbar_LWe7" id="issue-tracking--issue-type-mapping">Issue Tracking &gt; Issue Type Mapping<a class="hash-link" href="#issue-tracking--issue-type-mapping" title="Direct link to heading"></a></h6><p>DevLake will convert the issue types of &#x27;enhancement&#x27;, &#x27;proposal&#x27;, and &#x27;task&#x27; from Bitbucket into the new issue type &#x27;REQUIREMENT&#x27; for DevLake. In contrast, any issues classified as &#x27;bug&#x27; in Bitbucket will be converted into the new issue type &#x27;BUG&#x27; for DevLake. The original type will be saved in the column <code>original_type</code> of the table &#x27;issues&#x27;, and the new type will be saved in the column <code>type</code> of the same table.</p><h6 class="anchor anchorWithStickyNavbar_LWe7" id="cicd">CI/CD<a class="hash-link" href="#cicd" title="Direct link to heading"></a></h6><p>The CI/CD configuration for Bitbucket is used for calculating <a href="/docs/DORA">DORA metrics</a>.</p><p>By default, DevLake will identify the deployment and environment settings that are defined in the Bitbucket CI .yml file.</p><p><img loading="lazy" alt="Bitbucket Detect Deployments for DORA" src="/assets/images/bitbucket-detect-deployments-dora-2a348f671ae12c592e7cdaa06d31142e.png" width="851" height="104" class="img_ev3q"></p><p>However, to ensure this works properly, you must specify the deployment settings in the .yml file.
 <img loading="lazy" alt="Bitbucket Pipelines Deployment Settings" src="/assets/images/bitbucket-pipelines-deployment-settings-8aea8894395e6358a3e16b416b731680.png" width="1520" height="1024" class="img_ev3q"></p><p>The pipeline steps with the <code>deployment</code> key will be recognized as DevLake deployments. The value of the <code>deployment</code> key will be recognized as the environment of DevLake deployments.</p><p>All Bitbucket pipeline steps will be saved in table &#x27;cicd_tasks&#x27;, but DevLake deployments will be set as <code>type</code> = &#x27;deployment&#x27; and <code>environment</code> = &#x27;{Bitbucket-pipeline-step.deployment.value}&#x27;.</p><p>If you have not defined these settings in the .yml file, please select &#x27;Detect Deployments from Pipeline steps in Bitbucket&#x27;, and input the RegEx in the following fields:</p><p><img loading="lazy" alt="Bitbucket Detect Deployments Regex" src="/assets/images/bitbucket-detect-deployments-regex-2d8f607ac434c24b943d8434a96548f2.png" width="863" height="212" class="img_ev3q"></p><ul><li>Deployment: A pipeline step with a name that matches the given RegEx will be recognized as a DevLake deployment.</li><li>Production: A pipeline step with a name that matches the given RegEx will be recognized as a DevLake cicd_task in the production environment.</li></ul><h6 class="anchor anchorWithStickyNavbar_LWe7" id="introduction-to-bitbucket-ci-entities">Introduction to Bitbucket CI entities<a class="hash-link" href="#introduction-to-bitbucket-ci-entities" title="Direct link to heading"></a></h6><p>Bitbucket has several key CI entities: <code>pipelines</code>, <code>pipeline steps</code>, and <code>deployments</code>. A Bitbucket pipeline contains several pipeline steps. Each pipeline step defined with a deployment key can be mapped to a Bitbucket deployment.</p><p>Each Bitbucket pipeline is converted to a cicd_pipeline in DevLake&#x27;s domain layer schema and each Bitbucket pipeline step is converted to a cicd_task in DevLake&#x27;s domain layer.
 <img loading="lazy" alt="Bitbucket Pipeline interface showing CI entities and DevLake schema mapping" src="/assets/images/bitbucket-ci-entities-overview-3bf478962bcc2c357bde24d2860464da.png" width="2188" height="1204" class="img_ev3q"></p><p>If a pipeline step defines <code>deployment</code> with a value (usually indicating the environment), this pipeline step is also a Bitbucket deployment.</p><p><img loading="lazy" alt="Bitbucket Deployment view showing environment history with various pipeline runs" src="/assets/images/bitbucket-deployment-pipeline-history-fda2eb4376f26e0f02669bbf023ff503.png" width="2498" height="1450" class="img_ev3q"></p><h6 class="anchor anchorWithStickyNavbar_LWe7" id="additional-settings-optional">Additional Settings (Optional)<a class="hash-link" href="#additional-settings-optional" title="Direct link to heading"></a></h6><ul><li><p>Tags Limit: DevLake compares the last N pairs of tags to get the &quot;commit diff&#x27;, &quot;issue diff&quot; between tags. N defaults to 10.</p><ul><li>commit diff: new commits for a tag relative to the previous one</li><li>issue diff: issues solved by the new commits for a tag relative to the previous one</li></ul></li><li><p>Tags Pattern: Only tags that meet the given Regular Expression will be counted.</p></li><li><p>Tags Order: Only &quot;reverse semver&quot; order is supported for now.</p></li></ul><p>Please click <code>Save</code> to save the transformation rules for the repo. In the data scope list, click <code>Next Step</code> to continue configuring.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="step-2---collect-data-in-a-project">Step 2 - Collect Data in a Project<a class="hash-link" href="#step-2---collect-data-in-a-project" title="Direct link to heading"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="step-21---create-a-project">Step 2.1 - Create a Project<a class="hash-link" href="#step-21---create-a-project" title="Direct link to heading"></a></h3><p>Collecting Bitbucket data requires creating a project first. You can visit the Project page from the side menu and create a new project by following the instructions on the user interface.</p><p><img loading="lazy" alt="DevLake Project Creation Interface" src="/assets/images/create-a-project-20e220196044bbf9be564773c45c5990.png" width="1624" height="684" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="step-22---add-a-bitbucket-connection">Step 2.2 - Add a Bitbucket Connection<a class="hash-link" href="#step-22---add-a-bitbucket-connection" title="Direct link to heading"></a></h3><p>You can add a previously configured Bitbucket connection to the project and select the boards for which you wish to collect the data for.
 Please note: if you don&#x27;t see the repositories you are looking for, please check if you have added them to the connection first.</p><p><img loading="lazy" alt="DevLake Project Add Connection Interface" src="/assets/images/add-a-connection-project-4032e8e9a72cb4a6df81b6ced714205e.png" width="2394" height="624" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="step-23---set-the-sync-policy">Step 2.3 - Set the Sync Policy<a class="hash-link" href="#step-23---set-the-sync-policy" title="Direct link to heading"></a></h3><p>There are three settings for Sync Policy:</p><ul><li>Data Time Range: You can select the time range of the data you wish to collect. The default is set to the past six months.</li><li>Sync Frequency: You can choose how often you would like to sync your data in this step by selecting a sync frequency option or enter a cron code to specify your preferred schedule.</li><li>Skip Failed Tasks: sometime a few tasks may fail in a long pipeline; you can choose to skip them to avoid spending more time in running the pipeline all over again.</li></ul><p><img loading="lazy" alt="DevLake Sync Policy Settings" src="/assets/images/sync-policy-2ac941b2918fc873626375dfe4cbf5f5.png" width="2428" height="336" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="step-24---start-data-collection">Step 2.4 - Start Data Collection<a class="hash-link" href="#step-24---start-data-collection" title="Direct link to heading"></a></h3><p>Click on &quot;Collect Data&quot; to start collecting data for the whole project. You can check the status in the Status tab on the same page.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="troubleshooting">Troubleshooting<a class="hash-link" href="#troubleshooting" title="Direct link to heading"></a></h2><p>If you run into any problems, please check the <a href="/docs/Troubleshooting/Configuration">Troubleshooting</a> or <a href="https://github.com/apache/incubator-devlake/issues" target="_blank" rel="noopener noreferrer">create an issue</a>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/devlake-website/edit/main/docs/Configuration/BitBucket.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/Configuration/AzureDevOps"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Azure DevOps</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/Configuration/BitBucketServer"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Bitbucket Server/Data Center</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#step-1---add-data-connections" class="table-of-contents__link toc-highlight">Step 1 - Add Data Connections</a><ul><li><a href="#step-11---authentication" class="table-of-contents__link toc-highlight">Step 1.1 - Authentication</a></li><li><a href="#step-12---add-data-scopes" class="table-of-contents__link toc-highlight">Step 1.2 - Add Data Scopes</a></li><li><a href="#step-13---add-scope-config-optional" class="table-of-contents__link toc-highlight">Step 1.3 - Add Scope Config (Optional)</a></li></ul></li><li><a href="#step-2---collect-data-in-a-project" class="table-of-contents__link toc-highlight">Step 2 - Collect Data in a Project</a><ul><li><a href="#step-21---create-a-project" class="table-of-contents__link toc-highlight">Step 2.1 - Create a Project</a></li><li><a href="#step-22---add-a-bitbucket-connection" class="table-of-contents__link toc-highlight">Step 2.2 - Add a Bitbucket Connection</a></li><li><a href="#step-23---set-the-sync-policy" class="table-of-contents__link toc-highlight">Step 2.3 - Set the Sync Policy</a></li><li><a href="#step-24---start-data-collection" class="table-of-contents__link toc-highlight">Step 2.4 - Start Data Collection</a></li></ul></li><li><a href="#troubleshooting" class="table-of-contents__link toc-highlight">Troubleshooting</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/GettingStarted">Getting Started</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/DataModels/DevLakeDomainLayerSchema">Data Models</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/Metrics">Engineering Metrics</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://join.slack.com/t/devlake-io/shared_invite/zt-1lkgbdmys-AU2azidzO1u~mtjlg9my7A" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack</a></li><li class="footer__item"><a href="https://github.com/apache/incubator-devlake/issues" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub Issue Tracker</a></li><li class="footer__item"><a href="https://github.com/apache/devlake-website/issues" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub Issue Tracker For Docs</a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/apache/devlake" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub</a></li><li class="footer__item"><a href="https://twitter.com/ApacheDevLake" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter</a></li><li class="footer__item"><a class="footer__link-item" href="/community/trademark">Trademark Guidelines</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
         <div style="margin-top: 20px">
           <a href="https://incubator.apache.org/" target="_blank"><img style="height:40px; margin-bottom: 10px; margin-top: 10px" alt="Apache Software Foundation" src="/img/apache-incubator.svg"></a>
           <p style="text-align:left; font-weight: 300; font-size: 0.8em;">Apache DevLake is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p>
           <p style="text-align:left; font-weight: 300; font-size: 0.8em;">Copyright ©2026 Apache DevLake, DevLake, Apache, the Apache feather logo and the Apache DevLake project logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.</p>
         </div>
         </div></div></div></footer></div>
 <script src="/assets/js/runtime~main.566cb87a.js"></script>
 <script src="/assets/js/main.c5c21f25.js"></script>
 </body>
 </html>