You can access Bamboo's data from an external program by using Bamboo's REST-style remote API. The remote API is disabled by default. Bamboo will return an error if people try to use the remote API when it is disabled. Please note, the Bamboo remote API described in Bamboo Remote API - Deprecated has been deprecated in favour of the new Bamboo REST APIs. You only need to enable the 'Accept remote API calls?' option (as described below), if you want to allow access to the deprecated remote API. Access to the new REST API is enabled by default. |
On this page: |
Enabling the Remote API
To enable the remote API:
- Click the 'Administration' link in the top navigation bar.
- Click the 'General Configuration' link in the left navigation column under the 'System' section.
- Select the 'Accept remote API calls?' check-box.
- Click the 'Save' button. Bamboo will now accept remote calls. You do not have to restart the Bamboo server.
Notes
Related Topics
- Looking for more API documentation? For documentation on the deprecated Bamboo remote API, see Bamboo Remote API - Deprecated. For documentation on the new Bamboo REST API, see Bamboo REST APIs.