Deleting a branch using the API

How do I use the DELETE endpoint of the REST API for branches?

https://developer.atlassian.com/static/rest/bitbucket-server/5.5.0/bitbucket-branch-rest.html

Looking at this, I'm supposed to send a request object with the DELETE, but DELETE doesn't support passing an object?

The endpoint should simply be a request to 

/rest/branch-utils/1.0/projects/{projectKey}/repos/{repositorySlug}/branches?name=somebranch&dryRun=true

 

I don't know how you'll handle the /refs/head/- and forward slashes people use in their requests. But it seems wrong to imply that people should pass an object with their DELETE request.

 

Or do it like a POST request, to a 

/rest/branch-utils/1.0/projects/{projectKey}/repos/{repositorySlug}/delete

With the object, with the name and dryRyn - that would work right out of the box. And the branch-target is inferred by the branch-utils in the beginning of the API.

1 answer

0 votes

Hi Nicolaj,

The delete rest end point requires the ref to be specified as part of the input request, not in the URL itself. 

 

If you expand the "Example request representations", you'll get an example json file:

{
    "name": "refs/heads/my-branch",
    "dryRun": false
}

 

Add this to your request to provide the input file:

-H "Content-Type: application/json" --data @input.json 

 

Cheers,

Caterina

Suggest an answer

Log in or Join to answer
Community showcase
Piotr Plewa
Published Dec 27, 2017 in Bitbucket

Recipe: Deploying AWS Lambda functions with Bitbucket Pipelines

Bitbucket Pipelines helps me manage and automate a number of serverless deployments to AWS Lambda and this is how I do it. I'm building Node.js Lambda functions using node-lambda&nbsp...

635 views 0 4
Read article

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
Atlassian Team Tour

Join us on the Team Tour

We're bringing product updates and pro tips on teamwork to ten cities around the world.

Save your spot