This documentation relates to an earlier version of Bamboo.
View

Unknown macro: {spacejump}

or visit the current documentation home.

The following methods allow you to interact with your plans. You will require an authentication token for most of these methods.

Update And Build

Instruct Bamboo to checkout the latest version of the build and build it. This is typically used by a CVS/SVN trigger script.

This method does not use the standard API authentication mechanism. Bamboo will only accept this remote call if it originated from the IP address of the source control server.

Arguments:

Parameter Name

説明

buildKey

key identifier of the build you want to trigger

URL:

/api/rest/updateAndBuild.action

Successful Response:

<response>
    <success>A build of Moo was triggered by remote http call.</success>
</response>

Execute Build

Instruct Bamboo to checkout the latest version of the build and build it. This is typically used to trigger a manual build.

This method uses the standard authentication API.

Arguments:

Parameter Name

説明

auth

Authentication token retrieved via the login method

buildKey

key identifier of the build you want to trigger

URL:

/api/rest/executeBuild.action

例: 

/api/rest/executeBuild.action?auth=HGYj89Kju&buildKey=BAM-MAIN

Successful Response:

<response>
    <string>OK a build has been triggered.</string>
</response>

List Projects

Provides a list of all the projects on this Bamboo server.

Arguments:

Parameter Name

説明

auth

Authentication token retrieved via the login method

URL:

/api/rest/listProjectNames.action

Successful Response:

<response>
    <project>
        <name>My Awesome Project</name>
        <key>MY_PROJECT</key>
    </project>
</response>

要素

説明

Value Range

プロジェクト

Represents an individual project

 

name

プロジェクト名

User friendly name that appears in Bamboo.

鍵 (キー)

プロジェクト キー

Project identifier

Get Project Details

Provides details about a specific Bamboo Project.

Arguments:

Parameter Name

説明

auth

Authentication token retrieved via the login method

projectKey

Identifying key of the project required

URL:

/api/rest/getProjectDetails.action

例: 

/api/rest/getProjectDetails.action?auth=m3OaZ14Ck2&projectKey=MY_PROJECT

Successful Response:

<response>
<project>
     <name>${project.name}</name>
     <key>${project.key}</key>
     <currentStatus>${project.currentStatus}</currentStatus>
</project>
</response>

要素

説明

Value Range

プロジェクト

Represents an individual project

 

name

プロジェクト名

User friendly name that appears in Bamboo.

鍵 (キー)

プロジェクト キー

Project identifier

currentStatus

Provides an overall status of the project

"current" if any builds are building "fail" if any builds are failing, otherwise "success"

List Build Plans

Provides a list of all the build plans on this Bamboo server.

Arguments:

Parameter Name

説明

auth

Authentication token retrieved via the login method

URL:

/api/rest/listBuildNames.action

Successful Response:

<response>
    <build enabled=true">
         <name>My Project - Trunk</name>
         <key>MYPROJECT-TRUNK</key>
    </build>
    <build enabled=false">
         <name>My Project - Branch</name>
         <key>MYPROJECT-BRANCH</key>
    </build>
</response>

要素

説明

Value Range

ビルド

Represents an individual build plan

 

enabled

Whether or not the build plan is enabled (as opposed to disabled)

true/false

name

Full plan name

User friendly name that appears in Bamboo (includes project name)

鍵 (キー)

Full plan Key

Build plan identifier in the form <projectkey>-<planKey>

  • ラベルなし



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.