Showing results for 
Search instead for 
Did you mean: 
Sign up Log in

It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

Setting Repo description with rest api

None of the examples or documentation I can find for creating or updating a repository using the rest api for bitbucket server, show how to set the repo description.

Is there documentation for the full set of values that can be configured using the api?

How can you set the description?

This is for Bitbucket server / data center, not cloud.



2 answers

1 accepted

0 votes
Answer accepted

Check this page for the rest end points and what you can update:


I was able to write code to update the repo name so I’m sure there is an endpoint for the description 

Just change the link to the version of Bitbucket you are on to get a more precise list

Thank you for the response.

It turns out it is just a key named "description", but I had another error in my JSON, so it was failing, leading me to believe I had the wrong key.

0 votes

You will have to use PUT and send the new description in the data.


try setting the description on the front end and then do the standard get and see if the description field is listed in that response. If it is then the above should work. 

@Stephen Crandell

I have added description and put still not getting success, I have created blank repo using rest api now adding description gives error

    "name": "My repo",
    "forkable": false,
    "project": {
        "key": "PRJ"
    "description": "MY desc"

Suggest an answer

Log in or Sign up to answer
Community showcase
Published in Bitbucket

New improvements to user management in Bitbucket Cloud 👥

Hey Community! We’re willing to wager that quite a few of you not only use Bitbucket, but administer it too. Our team is excited to share that we’ll be releasing improvements throughout this month of...

3,741 views 10 16
Read article

Community Events

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

Find an event

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

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you