This page last changed on Mar 09, 2009 by bmccoy.

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.

REST

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

Authentication

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
Document generated by Confluence on Mar 09, 2009 17:07