This documentation relates to an earlier version of Bamboo.
View

Unknown macro: {spacejump}

or visit the current documentation home.

Remote API Deprecated

The Bamboo remote API described on this page has been deprecated in favour of the new Bamboo REST APIs. Please read the Bamboo REST API documentation before referring to the documentation below.

This section describes the ways of accessing the Bamboo remote API. Note that the terminology used in the REST API method and parameter names and descriptions may differ from what is used in the Bamboo UI. In some cases it follows conventions used within the Bamboo code.

To use Bamboo's remote API you will need to enable remote API access from within Bamboo itself. Instructions on how to do this can be found here: Enabling Bamboo's Remote API.

On this page:

RESTful

Whilst the Remote API capabilities of Bamboo are not true REST methods, they are RESTful and follow a similar format. The various API methods are accessed from /api/rest/METHOD-NAME

認証

Bamboo requires authentication to access the remote API. All methods accept an authentication token parameter.

An authentication token can be acquired (and released) using the login() and logout() methods. The authentication will expire after 30 minutes of inactive use.

Error Responses

The successful response is outlined for each individual method, error responses have the following format:

<errors>
<error>Error message one</error>
<error>Error message two</error>
</errors>

Methods

Authentication Services​
Build Services​
Build Results Services​
Build Results Filters​
Elastic Bamboo Services​
Other Services​



Log a request with our support team.



Raise an issue for our developers.



See answers from the community.



Tweet, blog and update our documentation.

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.