Skip to content

Overview

Code against the Bitbucket API to automate simple tasks, embed Bitbucket data into your own site, build mobile or desktop apps, or even add custom UI add-ons into Bitbucket itself using the Connect framework.

Basic HTTP Authentication as per RFC-2617 (Digest not supported). Note that Basic Auth is available only with username and app password as credentials.

Security scheme type: http

OAuth 2 as per RFC-6749.

Security scheme type: oauth2

Flow type: authorizationCode

Authorization URL: https://bitbucket.org/site/oauth2/authorize

Token URL: https://bitbucket.org/site/oauth2/access_token

Scopes:

  • repository - Read your repositories
  • repository:write - Read and modify your repositories
  • repository:admin - Administer your repositories
  • repository:delete - Delete your repositories
  • project - Read your workspace's project settings and read repositories contained within your workspace's projects
  • project:admin - Read and modify settings for projects in your workspace
  • email - Read your account's primary email address
  • account - Read your account information
  • account:write - Read and modify your account information
  • team - Read your team membership information
  • team:write - Read and modify your team membership information
  • pipeline - Access your repositories' build pipelines
  • pipeline:write - Access and rerun your repositories' build pipelines
  • pipeline:variable - Access your repositories' build pipelines and configure their variables
  • runner - Access your workspaces/repositories' runners
  • runner:write - Access and edit your workspaces/repositories' runners
  • test - Access your workspaces/repositories' test
  • test:write - Access and edit your workspaces/repositories' test
  • issue - Read your repositories' issues
  • issue:write - Read and modify your repositories' issues
  • pullrequest - Read your repositories and their pull requests
  • pullrequest:write - Read and modify your repositories and their pull requests
  • snippet - Read your snippets
  • snippet:write - Read and modify your snippets
  • webhook - Read and modify your repositories' webhooks
  • wiki - Read and modify your repositories' wikis

API Keys can be used as Basic HTTP Authentication credentials and provide a substitute for the account’s actual username and password. API Keys are only available to team accounts and there is only 1 key per account. API Keys do not support scopes and have therefore access to all contents of the account.

Security scheme type: apiKey

Header parameter name: Authorization