ATatlassian
Refs

Create a branch

Changed on

Creates a new branch in the specified repository.

The payload of the POST should consist of a JSON document that contains the name of the tag and the target hash.

curl https://api.bitbucket.org/2.0/repositories/seanfarley/hg/refs/branches \
-s -u seanfarley -X POST -H "Content-Type: application/json" \
-d '{
    "name" : "smf/create-feature",
    "target" : {
        "hash" : "default",
    }
}'

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

The branch name should not include any prefixes (e.g. refs/heads). This endpoint does support using short hash prefixes for the commit hash, but it may return a 400 response if the provided prefix is ambiguous. Using a full commit hash is the preferred approach.

post/repositories/{workspace}/{repo_slug}/refs/branches

Request

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

Response

The newly created 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