Why branch permissions don't work?

I want to restrict push to master branch with API request. I execute a query:

POST bitbucket_url/rest/branch-permissions/2.0/projects/project_name/repos/repo_name/restrictions

with parameters
 
{
    "matcher": {
        "id": "master",
        "displayId": "master",
        "type": {
            "id": "BRANCH",
        },
        "active": True,
    },
    "type": "pull-request-only",
    "users": [],
    "groups": some_groups
}

But it doesn't work. Branch restrictions are created and don't work (users can push into master without pull requests).

If I manually create the same branch restrictions, they work.

My Bitbucket version: 4.9.0 

 

Sincerely,
Anna.

1 answer

0 vote

Hi Anna, 

the branch permissions API expects the id on the BRANCH matcher to be a "fully qualified ref". From the docs

You must supply the fully qualified name of the ref to restrict, e.g. "refs/heads/master" instead of "master".

The example you provided is almost right, but you'll need to change the id to refs/heads/master:

 

{
    "matcher": {
        "id": "refs/heads/master",
        "displayId": "master",
        "type": {
            "id": "BRANCH",
        },
        "active": True,
    },
    "type": "pull-request-only",
    "users": [],
    "groups": some_groups
}

That should give you the restriction you want. 

 

Hope that helps, 

Felix

 

Suggest an answer

Log in or Sign up to answer
How to earn badges on the Atlassian Community

How to earn badges on the Atlassian Community

Badges are a great way to show off community activity, whether you’re a newbie or a Champion.

Learn more
Community showcase
Posted Jun 12, 2018 in Bitbucket

Do you use any Atlassian products for your personal projects?

After spinning my wheels trying to get organized enough to write a book for National Novel Writing Month (NaNoWriMo) I took my affinity for Atlassian products from my work life and decided to tr...

27,767 views 26 12
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you