Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
Community Members
Community Events
Community Groups

API or CLI to access to Repository information within Bamboo Plans

We are looking at extracting the repository information (server, repo, authentication info) for a given Bamboo plan by calling the Bamboo API.

I cannot seem to find any API endpoint on this. I wonder if I miss anything or any thing available through Bamboo CLI.

1 answer

0 votes

Hello @Eddy Siauwidjaja, Welcome to Atlassian Community!

You can do this by querying the database. Though doable through the API, you'll have to run multiple API checks and parse the output multiple times to get to a similar result.

Please check the following KB. The provided queries may require some extension depending on your requirement, but they are already a good start.



Eduardo Alvarenga
Atlassian Support APAC

Thank you, @Eduardo Alvarenga  - if doable via API, we prefer the API path as we already have other scripts running via API. Could you please share which end point to use? I can't seem to find the one that can return the Plan's repository information.

Secondly, I need to create the repo reference to the new repo via API and map the Plan to the new repo reference as well. are there such API endpoints? 

I noticed this is available through Bamboo CLI plugins. I assume Bamboo CLI will wrap some kind of API behind the scene. I can't seem to find it in the Bamboo's API reference. I must have missed something.

Hello @Eddy Siauwidjaja 

I would use the following endpoints:

  1. Dump the plan as YAML specs:
    2. The YAML contents will be on the Json's .spec.code
  2. If the repository is a Plan repository, you will find the details there already
  3. If the repository has a "global" or "project" scope, you will need to get the details on another REST call:
    2. You will need to use the searchTerm or you can use an empty searchTerm to return all Linked repositories.
    3. For each Linked repository, access the provided searchResults.url for and parse the HTML output to retrieve the details of it. You can use a tool such as xidel to parse it.

There is no way to make changes to a Plan via the API. You will have to use Bamboo Specs for that.



Eduardo Alvarenga
Atlassian Support APAC

Thank you again, @Eduardo Alvarenga 


Unfortunately, I cannot use any UI - as I have to deal with thousands of plans.

I need an API way to do the above steps. Please share the API endpoints to do the above. 

All the API endpoints are listed in my previous message.

Suggest an answer

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

Bamboo Data Center on Kubernetes

Hi, If you are running self-managed environments and looking to adopt modern infrastructure, Bamboo Data Center can now be deployed in a Kubernetes cluster. By leveraging Kubernetes, you can easily...

946 views 3 8
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