Where can I find documentation for Bamboo's remote trigger API?

I just used an Atlassian article to configure my team's integration between BitBucket Cloud and Bamboo Server. I would like to understand the API better, but I can't locate the documentation. Specifically, I want to know:

  • What does the skipBranches flag do?
  • What other parameters are available?

I expected to find it here: https://docs.atlassian.com/atlassian-bamboo/REST/6.2.3/

BAMBOO_URL/rest/triggers/1.0/remote/changeDetection?planKey=PLAN_KEY&skipBranches=false

 

3 answers

1 accepted

2 votes

Hello Jason,

The endpoint is not available in Bamboo's REST API documentation, I am afraid. Now, going back to your inquire:

  • What does the skipBranches flag do?
    By default, the change detection will run for all branches. If this parameter is set to true, the change detection will run only for the chain
  • What other parameters are available?
    planKey and skipBranches are the only parameters available

Kind regards,

Rafael

0 votes

Hi Jason,

I checked with the Bamboo team and it doesn't look like there is any public documentation for the Remote Trigger API as it's not public and isn't meant to be used in API calls at this time as all the publicly documented API calls can be found in the document you linked to.

I would encourage you to go to JAC and create a Suggestion ticket to get this added to the public API and documentation created for it.

Cheers,

Branden

0 votes

Although we don't generate documentation to that REST endpoint, it's officially supported and should be used for integration. See Rafael's answer for explanation of the parameters.

Suggest an answer

Log in or Join to answer
Community showcase
Renan Battaglin
Published May 18, 2017 in Bamboo

FAQ: How to Upgrade Bamboo Server

Bamboo 5.9 will no longer be supported after June 12, 2017. What does this mean? As part of our End of Life policy, Atlassian supports major versions for two years after the first major iteratio...

1,072 views 0 5
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