Is it possible to know through an API if a branch is main branch?

Nimrod Golan

Is it possible to know through an API if a branch is set as a main branch?

wasn't able to see anything about it. only thing was on the UI itself where when it lists the branches, each branch entity has the 'ismainbranch' property, but on the official API documentations there is nothing... 

Theodora Boudale

Hi Nimrod,

You can use the following API endpoint to get a repository's main branch:

• https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-repositories-workspace-repo-slug-get

You can request a partial response and only get the main branch with a call like this:

curl --request GET \
--url 'https://api.bitbucket.org/2.0/repositories/workspace-id/repo?fields=mainbranch.name' \
--header 'Authorization: Bearer access-token' \
--header 'Accept: application/json'

 

It is also possible to get this info with the endpoint that gets a branch:

• https://developer.atlassian.com/cloud/bitbucket/rest/api-group-refs/#api-repositories-workspace-repo-slug-refs-branches-name-get

If you don't request a partial response you'll need to use field discovery:

curl --request GET \
--url 'https://api.bitbucket.org/2.0/repositories/workspace-id/repo/refs/branches/somebranch?fields=*.*.*.*' \
--header 'Authorization: Bearer access_token' \
--header 'Accept: application/json'

You can also request a partial response as follows:

curl --request GET \
--url 'https://api.bitbucket.org/2.0/repositories/workspace-id/repo/refs/branches/somebranch?fields=target.repository.mainbranch.name' \
--header 'Authorization: Bearer access_token' \
--header 'Accept: application/json'

Please feel free to reach out if you have any questions!

Kind regards,
Theodora