ATatlassian
Refs

Get a branch

Changed on

Returns a branch object within the specified repository.

This call requires authentication. Private repositories require the caller to authenticate with an account that has appropriate authorization.

For Git, the branch name should not include any prefixes (e.g. refs/heads).

get/repositories/{workspace}/{repo_slug}/refs/branches/{name}

Request

  • Base URL
    https://api.bitbucket.org/2.0
  • URL
    https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/refs/branches/{name}
  • Auth
    • OAuth 2
      Authorization code: https://bitbucket.org/site/oauth2/authorize
      Token URL: https://bitbucket.org/site/oauth2/access_token scopes: repository
    • or HTTP basic
    • or API key in header Authorization

Response

The branch object.

typestring required
namestring

The name of the ref.

merge_strategiesstring[]

Available merge strategies for pull requests targeting this branch.

default_merge_strategystring

The default merge strategy for pull requests targeting this branch.

Changes

  • d344164ecb11Revision changes
    • warning

      removed the optional property /////////// from the response with the status

    • warning

      removed the optional property //////// from the response with the status

    • warning

      added the new rebase_fast_forward enum value to the // response property for the response status

    • warning

      added the new rebase_merge enum value to the // response property for the response status

    • warning

      added the new squash_fast_forward enum value to the // response property for the response status

    • info

      added the optional property /////// to the response with the status