Bamboo REST API documentation

/deploy/result

Methods

/deploy/result/{deploymentResultId}?includeLogs

resource-wide template parameters

parameter	value	description
deploymentResultId	long

Methods

GET

request query parameters

parameter	value	description
includeLogs	boolean

available response representations:

application/json (deploymentResult) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="deploymentResult" type="restDeploymentResult"/><xs:element name="deploymentResult" type="restDeploymentResult"/>

/capability

Methods

/capability/groupedListing?searchTerm&lastGroup

Methods

GET

Provides a list of capabilities for a select list in the UI. Filterable and paginable

request query parameters

parameter	value	description
searchTerm	string
lastGroup	string

available response representations:

application/json [expand]

/project

Methods

GET

Method used to list all projects defined in Bamboo. Permissions for projects are checked based on Plan permissions (no project level permissions in Bamboo) Projects without any plan visible for user are not listed Should be invoked as /rest/api/latest/project <p> Possible expand parameters projects - list of projects projects.project - list of projects with project details projects.project.plans - list of project details and plans for project projects.project.plans.plan - list of project details and plans for project with plan details

available response representations:

application/xml (projects) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="projects" type="restProjects"/><xs:element name="projects" type="restProjects"/>

application/json (projects) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="projects" type="restProjects"/><xs:element name="projects" type="restProjects"/>

/project/{projectKey}

resource-wide template parameters

parameter	value	description
projectKey	string

Methods

GET

Method used to retrieve information for project specified as project key Should be invoked as /rest/api/latest/project/PROJECTKEY <p> Possible expand parameters plans - list of plans for project plans.plan - list of plans with plan details (only plans visible - READ permission for user) plans.plan.actions - list of plans with plan details and actions available for user for plan

available response representations:

application/xml (project) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="project" type="restProject"/><xs:element name="project" type="restProject"/>

application/json (project) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="project" type="restProject"/><xs:element name="project" type="restProject"/>

/search

Methods

/search/users?searchTerm&includeAvatars

Methods

GET

A starts-with search of users based on their username, full-name and if allowed email address.

request query parameters

parameter	value	description
searchTerm	string	Mandatory. The term to search for in users.
includeAvatars	boolean	if true will include avatar urls in the response. If gravatar is not enabled, no urls will be returned

available response representations:

200 - application/xml, application/json (searchResultsList) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<searchResults start-index="0" max-result="1" size="1">
    <searchResults id="jsmith" type="user">
        <searchEntity xsi:type="userSearchResult" id="jsmith" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <username>jsmith</username>
            <fullName>John Smith</fullName>
            <displayableEmail>jsmith@example.com</displayableEmail>
            <avatarUrl>https://secure.gravatar.com/avatar/asdfasdfasdfasdf.jpg?d=mm&amp;s=16&amp;r=g</avatarUrl>
        </searchEntity>
    </searchResults>
</searchResults>

Search results for users matching the provided search term

XML Schema

Source: xsd0.xsd

<xs:complexType name="searchResultsList">
    <xs:sequence>
      <xs:element name="searchResults" type="searchResult" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="start-index" type="xs:int" use="required"/>
    <xs:attribute name="max-result" type="xs:int" use="required"/>
    <xs:attribute name="size" type="xs:int" use="required"/>
  </xs:complexType><xs:complexType name="searchResultsList">
    <xs:sequence>
      <xs:element name="searchResults" type="searchResult" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="start-index" type="xs:int" use="required"/>
    <xs:attribute name="max-result" type="xs:int" use="required"/>
    <xs:attribute name="size" type="xs:int" use="required"/>
  </xs:complexType>

/search/authors?searchTerm&unlinkedOnly

Methods

GET

A starts-with search of authors based on their authorname,

request query parameters

parameter	value	description
searchTerm	string	Mandatory. The term to search for in authors.
unlinkedOnly	boolean	if true will only include authors which are not currently linked to a user.

available response representations:

200 - application/xml, application/json (searchResultsList) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<searchResults start-index="0" max-result="1" size="1">
    <searchResults id="jsmith" type="author">
        <searchEntity xsi:type="authorSearchResult" id="jsmith" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <authorName>jsmith</authorName>
        </searchEntity>
    </searchResults>
</searchResults>

Search results for authors matching the provided search term

XML Schema

Source: xsd0.xsd

<xs:complexType name="searchResultsList">
    <xs:sequence>
      <xs:element name="searchResults" type="searchResult" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="start-index" type="xs:int" use="required"/>
    <xs:attribute name="max-result" type="xs:int" use="required"/>
    <xs:attribute name="size" type="xs:int" use="required"/>
  </xs:complexType><xs:complexType name="searchResultsList">
    <xs:sequence>
      <xs:element name="searchResults" type="searchResult" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="start-index" type="xs:int" use="required"/>
    <xs:attribute name="max-result" type="xs:int" use="required"/>
    <xs:attribute name="size" type="xs:int" use="required"/>
  </xs:complexType>

/search/plans?searchTerm

Methods

GET

Performs a "starts with" search against full plan name and full plan key. Use "type" argument to filter by plan type by default will return TopLevelPlans

request query parameters

parameter	value	description
searchTerm	string	to search for. Optional

available response representations:

application/xml (searchResults) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="searchResults" type="searchResultsList"/><xs:element name="searchResults" type="searchResultsList"/>

application/json (searchResults) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="searchResults" type="searchResultsList"/><xs:element name="searchResults" type="searchResultsList"/>

/search/jobs/{planKey}?searchTerm

resource-wide template parameters

parameter	value	description
planKey	string	planKey for plan where jobs will be searched for

Methods

GET

Performs a "starts with" search against full job name and full job key. Use "type" argument to filter by plan type by default will return TopLevelPlans

request query parameters

parameter	value	description
searchTerm	string	to search for. Optional

available response representations:

application/xml (searchResults) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="searchResults" type="searchResultsList"/><xs:element name="searchResults" type="searchResultsList"/>

application/json (searchResults) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="searchResults" type="searchResultsList"/><xs:element name="searchResults" type="searchResultsList"/>

/search/stages/{planKey}?stageId&searchTerm

resource-wide template parameters

parameter	value	description
planKey	string

Methods

GET

Performs a "starts with" search against full job name and full job key. Use "type" argument to filter by plan type by default will return TopLevelPlans

request query parameters

parameter	value	description
stageId	string
searchTerm	string

available response representations:

application/xml (searchResults) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="searchResults" type="searchResultsList"/><xs:element name="searchResults" type="searchResultsList"/>

application/json (searchResults) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="searchResults" type="searchResultsList"/><xs:element name="searchResults" type="searchResultsList"/>

/search/branches?masterPlanKey&includeMasterBranch&releasedInDeployment&searchTerm

Methods

GET

Performs a "starts with" search against full plan branch name and full plan branch key. Branches are restricted to "masterPlanKey" plan.

request query parameters

parameter	value	description
masterPlanKey	string
includeMasterBranch	boolean
releasedInDeployment	int
searchTerm	string

available response representations:

application/xml (searchResults) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="searchResults" type="searchResultsList"/><xs:element name="searchResults" type="searchResultsList"/>

application/json (searchResults) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="searchResults" type="searchResultsList"/><xs:element name="searchResults" type="searchResultsList"/>

/search/projects?searchTerm

Methods

GET

Performs a contains search against project name.

request query parameters

parameter	value	description
searchTerm	string	to search for. Optional

available response representations:

application/xml (searchResults) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="searchResults" type="searchResultsList"/><xs:element name="searchResults" type="searchResultsList"/>

application/json (searchResults) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="searchResults" type="searchResultsList"/><xs:element name="searchResults" type="searchResultsList"/>

/search/versions?searchTerm&deploymentProjectId&branchKey&chronologicalOrder

Methods

GET

Performs a contains search against a version name.

request query parameters

parameter	value	description
searchTerm	string
deploymentProjectId	long
branchKey	string
chronologicalOrder	boolean

available response representations:

application/xml (searchResults) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="searchResults" type="searchResultsList"/><xs:element name="searchResults" type="searchResultsList"/>

application/json (searchResults) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="searchResults" type="searchResultsList"/><xs:element name="searchResults" type="searchResultsList"/>

/deploy/project

Methods

PUT

acceptable request representations:

application/json (deploymentProject) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="deploymentProject" type="restDeploymentProject"/><xs:element name="deploymentProject" type="restDeploymentProject"/>

available response representations:

application/json (deploymentProject) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="deploymentProject" type="restDeploymentProject"/><xs:element name="deploymentProject" type="restDeploymentProject"/>

/deploy/project/{id}

resource-wide template parameters

parameter	value	description
id	long

Methods

GET

available response representations:

application/json (deploymentProject) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="deploymentProject" type="restDeploymentProject"/><xs:element name="deploymentProject" type="restDeploymentProject"/>

POST

acceptable request representations:

application/json (deploymentProject) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="deploymentProject" type="restDeploymentProject"/><xs:element name="deploymentProject" type="restDeploymentProject"/>

available response representations:

application/json (deploymentProject) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="deploymentProject" type="restDeploymentProject"/><xs:element name="deploymentProject" type="restDeploymentProject"/>

/deploy/project/all

Methods

GET

Return all Package Definitions, including jobs.

available response representations:

200 - [expand]

/deploy/project/{projectId}/versions?branchKey

resource-wide template parameters

parameter	value	description
projectId	long

Methods

GET

request query parameters

parameter	value	description
branchKey	string

available response representations:

application/json [expand]

/deploy/project/forPlan?planKey

Methods

GET

request query parameters

parameter	value	description
planKey	string

available response representations:

application/json (restLinkedDeploymentProject) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="restLinkedDeploymentProject" type="restLinkedDeploymentProject"/><xs:element name="restLinkedDeploymentProject" type="restLinkedDeploymentProject"/>

/agent/authentication?pending

Methods

GET

Provides a list of all agent authentication statuses. Use query parameter "pending = true/false" to filter only pending or only approved agents.

request query parameters

parameter	value	description
pending	boolean

available response representations:

200 - application/json [expand]

A successful call will return a complete (non-paginated) list of agent authentication statuses.

401 - application/json [expand]

A response with code HTTP 401 indicates that the calling user had insufficient permissions for the request.

/agent/authentication/{agentUuid}

resource-wide template parameters

parameter	value	description
agentUuid	string

Methods

PUT

Authenticates a pending agent with the given UUID. If the agent has already been authenticated, the call will not change it's state.

available response representations:

400 - application/json [expand]

A response with code HTTP 400 indicates that there were errors during request execution - for example data validation errors occurred (the provided UUID was invalid, no agent with the given UUID was found etc.).

401 - application/json [expand]

A response with code HTTP 401 indicates that the calling user had insufficient permissions for the request.

204 [expand]

No content response is sent after successful authentication of an agent.

/queue

Lists all the builds waiting in the build queue, adds or removes a build from the build queue. May be used also to resume build on manual stage or rerun failed jobs.

Methods

GET

Provide list of build scheduled for execution and waiting in build queue.

available response representations:

200 - application/xml, application/json (restQueuedBuilds) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<queue expand="queuedBuilds">
    <queuedBuilds start-index="0" max-result="1" size="0">
        <queuedBuild expand="queuedBuild" planKey="PROJECTKEY-PLANKEY" buildNumber="10" buildResultKey="PROJECTKEY-PLANKEY-10">
            <triggerReason>Manual build</triggerReason>
            <changes expand="changes" start-index="0" max-result="2" size="0">
                <change expand="change" author="Author" changesetId="10">
                    <comment>Sample comment</comment>
                    <date>2016-02-08T09:26:00.619Z</date>
                    <files start-index="0" max-result="3" size="0">
                        <file>
                            <name>some/example/path/to/File.java</name>
                            <revision>10</revision>
                        </file>
                        <file>
                            <name>some/example/path/to/File.java</name>
                            <revision>10</revision>
                        </file>
                        <file>
                            <name>some/example/path/to/File.java</name>
                            <revision>10</revision>
                        </file>
                    </files>
                </change>
                <change expand="change" author="Author" changesetId="10">
                    <comment>Sample comment</comment>
                    <date>2016-02-08T09:26:00.619Z</date>
                    <files start-index="0" max-result="3" size="0">
                        <file>
                            <name>some/example/path/to/File.java</name>
                            <revision>10</revision>
                        </file>
                        <file>
                            <name>some/example/path/to/File.java</name>
                            <revision>10</revision>
                        </file>
                        <file>
                            <name>some/example/path/to/File.java</name>
                            <revision>10</revision>
                        </file>
                    </files>
                </change>
            </changes>
        </queuedBuild>
    </queuedBuilds>
</queue>

List of queued builds waiting in the build queue

XML Schema

Source:

/queue/{projectKey}-{buildKey}?stage&executeAllStages&customRevision

resource-wide template parameters

parameter	value	description
projectKey	string
buildKey	string

Methods

POST

Fire build execution for specified plan. Effectively, this method adds build to the build queue, so is not guarantied that build would be executed immediately. Depending on currently executed builds and length of build queue, build may be executed when queue would be drained. Additional variables could be passed to this method either as form encoded POST payload or query parameters. PLEASE note: Query parameters are more important - override those stored in form payload. Variables defined in Bamboo as global variables or plan variables MUST be prefixed with bamboo.variable ie. bamboo.variable.myVariable=valueForMyVariable. When global or plan variables would be passed to this method, will override default values for variables.

request query parameters

parameter	value	description
stage	string
executeAllStages	boolean
customRevision	string

acceptable request representations:

application/xml [expand]
application/json [expand]
application/x-www-form-urlencoded [expand]

available response representations:

200 - application/xml, application/json (restQueuedBuild) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<restQueuedBuild expand="queuedBuild" planKey="PROJECTKEY-PLANKEY" buildNumber="10" buildResultKey="PROJECTKEY-PLANKEY-10">
    <triggerReason>Manual build</triggerReason>
    <changes expand="changes" start-index="0" max-result="2" size="0">
        <change expand="change" author="Author" changesetId="10">
            <comment>Sample comment</comment>
            <date>2016-02-08T09:26:00.619Z</date>
            <files start-index="0" max-result="3" size="0">
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
            </files>
        </change>
        <change expand="change" author="Author" changesetId="10">
            <comment>Sample comment</comment>
            <date>2016-02-08T09:26:00.619Z</date>
            <files start-index="0" max-result="3" size="0">
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
            </files>
        </change>
    </changes>
</restQueuedBuild>

Information for queued build, including build number, changes and reason of build

XML Schema

Source:

400 [expand]

Returned when build was not added to the queue because of Bamboo limitation - for example too many concurrent builds running for requested plan already

401 [expand]

Returned when user does not have sufficient rights to view or execute build for specified plan

404 [expand]

Returned when specified plan does not exist or plan is not a top level plan

415 [expand]

Returned when POST method payload is not form encoded

/queue/{projectKey}-{buildKey}-{buildNumber : ([0-9]+)}?stage&executeAllStages

resource-wide template parameters

parameter	value	description
projectKey	string	project key
buildKey	string	plan key (only top level plan key, can not be job key)
buildNumber	int	build number to resume/rerun

Methods

PUT

Continue partially done build. Effectively, this method adds build to the build queue, so is not guarantied that build would be executed immediately. Depending on currently executed builds and length of build queue, build may be executed when queue would be drained. Additional variables could be passed to this method only query parameters (variableName=variableValue). Variables defined in Bamboo as global variables or plan variables MUST be prefixed with bamboo.variable ie. bamboo.variable.myVariable=valueForMyVariable. When global or plan variables would be passed to this method, will override values valid for previous build execution (override).

request query parameters

parameter	value	description
stage	string	name of the stage that should be executed even if manual stage. Execution will follow to the next manual stage after this or end of plan if no subsequent manual stage
executeAllStages	boolean	enforce executing all stages in a plan, even if defined as manual stages. Execution will follow and include latest stage, unless some stage will fail.

available response representations:

200 - application/xml, application/json (restQueuedBuild) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<restQueuedBuild expand="queuedBuild" planKey="PROJECTKEY-PLANKEY" buildNumber="10" buildResultKey="PROJECTKEY-PLANKEY-10">
    <triggerReason>Manual build</triggerReason>
    <changes expand="changes" start-index="0" max-result="2" size="0">
        <change expand="change" author="Author" changesetId="10">
            <comment>Sample comment</comment>
            <date>2016-02-08T09:26:00.619Z</date>
            <files start-index="0" max-result="3" size="0">
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
            </files>
        </change>
        <change expand="change" author="Author" changesetId="10">
            <comment>Sample comment</comment>
            <date>2016-02-08T09:26:00.619Z</date>
            <files start-index="0" max-result="3" size="0">
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
            </files>
        </change>
    </changes>
</restQueuedBuild>

Information for queued build, including build number, changes and reason of build

XML Schema

Source:

400 [expand]

Returned when build is currently executing or is in state not allowing execution

401 [expand]

Returned when user does not have sufficient rights to view or execute build for specified plan

404 [expand]

Returned when specified plan does not exist, result for provided build number does not exist or is not top level plan result

/queue/{projectKey}-{buildKey}-{buildNumber}

resource-wide template parameters

parameter	value	description
projectKey	string	project key
buildKey	string	plan key - IMPORTANT: as build queue contains only jobs not top level plans, plan key here MUST be a job key as opposite to other methods in this resource.
buildNumber	int	build number

Methods

DELETE

Stop build execution, however only if build has not been started yet - so if is waiting in the build queue. If build does not exist in the queue anymore, method has no effect.

available response representations:

401 [expand]

Returned when user does not have sufficient rights to view or execute build for specified plan

204 [expand]

On success (success is also when build doesn't exists in the queue - so nothing to stop)

404 [expand]

Returned when specified plan does not exist

/quicksearch?searchTerm

Methods

GET

Performs a starts with search against full plan name and full plan key. Use "type" argument to filter by plan type by default will return TopLevelPlans

request query parameters

parameter	value	description
searchTerm	string	to search for. Optional

available response representations:

application/json [expand]

/currentUser

Methods

GET

available response representations:

application/json (userBean) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="userBean" type="userBean"/><xs:element name="userBean" type="userBean"/>

application/xml (userBean) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="userBean" type="userBean"/><xs:element name="userBean" type="userBean"/>

/server

Methods

GET

available response representations:

application/xml (restServerStatusInfo) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="restServerStatusInfo" type="restServerStatusInfo"/><xs:element name="restServerStatusInfo" type="restServerStatusInfo"/>

application/json (restServerStatusInfo) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="restServerStatusInfo" type="restServerStatusInfo"/><xs:element name="restServerStatusInfo" type="restServerStatusInfo"/>

/server/pause

Methods

POST

Pauses the server

available response representations:

application/xml (restServerStatusInfo) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="restServerStatusInfo" type="restServerStatusInfo"/><xs:element name="restServerStatusInfo" type="restServerStatusInfo"/>

application/json (restServerStatusInfo) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="restServerStatusInfo" type="restServerStatusInfo"/><xs:element name="restServerStatusInfo" type="restServerStatusInfo"/>

/server/prepareForRestart

Methods

PUT

Prepare server for restarting: suspend change detection, stop indexing, stop ec2 instance ordering etc

available response representations:

application/xml (restServerStatusInfo) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="restServerStatusInfo" type="restServerStatusInfo"/><xs:element name="restServerStatusInfo" type="restServerStatusInfo"/>

application/json (restServerStatusInfo) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="restServerStatusInfo" type="restServerStatusInfo"/><xs:element name="restServerStatusInfo" type="restServerStatusInfo"/>

/server/resume

Methods

POST

Resumes the server

available response representations:

application/xml (restServerStatusInfo) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="restServerStatusInfo" type="restServerStatusInfo"/><xs:element name="restServerStatusInfo" type="restServerStatusInfo"/>

application/json (restServerStatusInfo) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="restServerStatusInfo" type="restServerStatusInfo"/><xs:element name="restServerStatusInfo" type="restServerStatusInfo"/>

/plan/favicon

Methods

/plan/favicon/{planKey}

resource-wide template parameters

parameter	value	description
planKey	string

Methods

GET

available response representations:

application/json (favicon) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="favicon" type="restFavicon"/><xs:element name="favicon" type="restFavicon"/>

/deploy/projectVersioning

Methods

/deploy/projectVersioning/{id}/variables

resource-wide template parameters

parameter	value	description
id	long

Methods

GET

available response representations:

application/json (versionVariables) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="versionVariables" type="versionVariables"/><xs:element name="versionVariables" type="versionVariables"/>

/deploy/projectVersioning/{id}/namingPreview?nextVersionName&incrementNumbers&incrementableVariables

resource-wide template parameters

parameter	value	description
id	long

Methods

GET

request query parameters

parameter	value	description
nextVersionName	string
incrementNumbers	boolean
incrementableVariables	string

available response representations:

application/json (restNamingPreview) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="restNamingPreview" type="restNamingPreview"/><xs:element name="restNamingPreview" type="restNamingPreview"/>

/deploy/projectVersioning/{id}/nextVersion?resultKey

resource-wide template parameters

parameter	value	description
id	long

Methods

GET

request query parameters

parameter	value	description
resultKey	string

available response representations:

application/json (restNamingPreview) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="restNamingPreview" type="restNamingPreview"/><xs:element name="restNamingPreview" type="restNamingPreview"/>

/deploy/projectVersioning/{id}/parseVariables?nextVersionName

resource-wide template parameters

parameter	value	description
id	long

Methods

GET

request query parameters

parameter	value	description
nextVersionName	string

available response representations:

application/json [expand]

/deploy/preview

Methods

/deploy/preview/result?resultKey&planKey&buildNumber&deploymentProjectId&previousVersionId

Methods

GET

request query parameters

parameter	value	description
resultKey	string
planKey	string
buildNumber	int
deploymentProjectId	long
previousVersionId	long

available response representations:

application/json (versionPreview) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="versionPreview" type="versionPreview"/><xs:element name="versionPreview" type="versionPreview"/>

/deploy/preview/version?versionName&versionId&deploymentProjectId&previousVersionId

Methods

GET

request query parameters

parameter	value	description
versionName	string
versionId	long
deploymentProjectId	long
previousVersionId	long

available response representations:

application/json (versionPreview) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="versionPreview" type="versionPreview"/><xs:element name="versionPreview" type="versionPreview"/>

/deploy/preview/possibleResults?planKey&deploymentProjectId

Methods

GET

request query parameters

parameter	value	description
planKey	string
deploymentProjectId	long

available response representations:

application/json [expand]

/deploy/preview/versionName?deploymentProjectId&resultKey

Methods

GET

request query parameters

parameter	value	description
deploymentProjectId	long
resultKey	string

available response representations:

application/json [expand]

/chart

Methods

GET

available response representations:

application/xml (chart) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="chart" type="restChart"/><xs:element name="chart" type="restChart"/>

application/json (chart) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="chart" type="restChart"/><xs:element name="chart" type="restChart"/>

/chart/reports

Methods

GET

available response representations:

application/xml (reports) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="reports" type="restReports"/><xs:element name="reports" type="restReports"/>

application/json (reports) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="reports" type="restReports"/><xs:element name="reports" type="restReports"/>

/chart/planSummary

Methods

GET

available response representations:

application/xml (chart) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="chart" type="restChart"/><xs:element name="chart" type="restChart"/>

application/json (chart) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="chart" type="restChart"/><xs:element name="chart" type="restChart"/>

/agent/assignment?executorType&executorId

Methods

GET

request query parameters

parameter	value	description
executorType	string
executorId	long

available response representations:

application/json (dedicatedAgent) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="dedicatedAgent" type="restDedicatedAgent"/><xs:element name="dedicatedAgent" type="restDedicatedAgent"/>

POST

request query parameters

parameter	value	description
executorType	string
executorId	long
assignmentType	string
entityId	long

available response representations:

application/json [expand]

DELETE

request query parameters

parameter	value	description
executorType	string
executorId	long
assignmentType	string
entityId	long

available response representations:

application/json [expand]

/agent/assignment/search?executorType&executorId&entityType&searchTerm

Methods

GET

request query parameters

parameter	value	description
executorType	string
executorId	long
entityType	string
searchTerm	string

available response representations:

application/json (searchResults) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="searchResults" type="searchResultsList"/><xs:element name="searchResults" type="searchResultsList"/>

/deploy/issue-status

Methods

/deploy/issue-status/{key}

resource-wide template parameters

parameter	value	description
key	string

Methods

GET

available response representations:

application/json (jiraIssueRelatedDeploymentProjects) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="jiraIssueRelatedDeploymentProjects" type="restJiraIssueRelatedDeploymentProjects"/><xs:element name="jiraIssueRelatedDeploymentProjects" type="restJiraIssueRelatedDeploymentProjects"/>

/deploy/issue-status/{key}/{deploymentProjectId}

resource-wide template parameters

parameter	value	description
deploymentProjectId	string
key	string

Methods

GET

available response representations:

application/json (deploymentProjectForJiraIssue) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="deploymentProjectForJiraIssue" nillable="true" type="xs:anyType"/><xs:element name="deploymentProjectForJiraIssue" nillable="true" type="xs:anyType"/>

/deploy/version

Methods

/deploy/version/{id}/status/{state}

resource-wide template parameters

parameter	value	description
id	string
state	string

Methods

POST

available response representations:

application/json (deploymentVersionStatus) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="deploymentVersionStatus" type="restDeploymentVersionStatus"/><xs:element name="deploymentVersionStatus" type="restDeploymentVersionStatus"/>

/deploy/version/{id}/status

resource-wide template parameters

parameter	value	description
id	string

Methods

GET

available response representations:

application/json (deploymentVersionStatus) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="deploymentVersionStatus" type="restDeploymentVersionStatus"/><xs:element name="deploymentVersionStatus" type="restDeploymentVersionStatus"/>

/elasticConfiguration

Methods

GET

available response representations:

application/json (elasticConfiguration) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="elasticConfiguration" type="restElasticImageConfig"/><xs:element name="elasticConfiguration" type="restElasticImageConfig"/>

POST

acceptable request representations:

application/json (elasticConfiguration) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="elasticConfiguration" type="restElasticImageConfig"/><xs:element name="elasticConfiguration" type="restElasticImageConfig"/>

available response representations:

application/json (elasticConfiguration) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="elasticConfiguration" type="restElasticImageConfig"/><xs:element name="elasticConfiguration" type="restElasticImageConfig"/>

/elasticConfiguration/{configurationId}

resource-wide template parameters

parameter	value	description
configurationId	long

Methods

GET

available response representations:

application/json (elasticConfiguration) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="elasticConfiguration" type="restElasticImageConfig"/><xs:element name="elasticConfiguration" type="restElasticImageConfig"/>

PUT

acceptable request representations:

application/json (elasticConfiguration) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="elasticConfiguration" type="restElasticImageConfig"/><xs:element name="elasticConfiguration" type="restElasticImageConfig"/>

available response representations:

application/json (elasticConfiguration) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="elasticConfiguration" type="restElasticImageConfig"/><xs:element name="elasticConfiguration" type="restElasticImageConfig"/>

DELETE

available response representations:

application/json [expand]

/elasticConfiguration/configuration-name/{configurationName}

resource-wide template parameters

parameter	value	description
configurationName	string

Methods

GET

available response representations:

application/json (elasticConfiguration) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="elasticConfiguration" type="restElasticImageConfig"/><xs:element name="elasticConfiguration" type="restElasticImageConfig"/>

PUT

acceptable request representations:

application/json (elasticConfiguration) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="elasticConfiguration" type="restElasticImageConfig"/><xs:element name="elasticConfiguration" type="restElasticImageConfig"/>

available response representations:

application/json (elasticConfiguration) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="elasticConfiguration" type="restElasticImageConfig"/><xs:element name="elasticConfiguration" type="restElasticImageConfig"/>

DELETE

available response representations:

application/json [expand]

/elasticConfiguration/image-id/{imageId}?newImageId

resource-wide template parameters

parameter	value	description
imageId	string

Methods

PUT

request query parameters

parameter	value	description
newImageId	string

available response representations:

application/json [expand]

/agent?online

Methods

GET

Provides a list of all agents. Use query parameter "online = true/false" to filter only online agents.

request query parameters

parameter	value	description
online	boolean

available response representations:

200 - application/json [expand]

A successful call will return a complete (non-paginated) list of agents

401 - application/json [expand]

A response with code HTTP 401 indicates that the calling user had insufficient permissions for the request.

/agent/remote?online

Methods

GET

Provides a list of all agent authentication statuses. Use query parameter "online = true/false" to filter only remote or only approved agents.

request query parameters

parameter	value	description
online	boolean

available response representations:

200 - application/json [expand]

A successful call will return a complete (non-paginated) list of remote agents

401 - application/json [expand]

A response with code HTTP 401 indicates that the calling user had insufficient permissions for the request.

/planDirectoryInfo

Returns information about the directories where artifacts, build logs, and build results will be stored. Disabled by default. See https://confluence.atlassian.com/display/BAMBOO/Plan+directory+information+REST+API for more information.

Methods

/planDirectoryInfo/{planKey}

resource-wide template parameters

parameter	value	description
planKey	string

Methods

GET

Provides the directories where artifacts and build logs can be found for a given plan key

available response representations:

200 - application/json (planDirectoryInfo) [expand]
Directories which may contain artifacts and log fiels for a given plan
XML Schema

Source:

/repository

Methods

/repository/testConnection

Methods

PUT

Tests connection to a repository if the repository type supports connection testing. Request payload should contain repository configuration.

acceptable request representations:

application/json [expand]

available response representations:

200 - application/json [expand]

Successful call (without validation errors) will result in HTTP 200. The response will contain potential connection errors. If the connection to repository was successful, the error list will be empty.

400 - application/json [expand]

A response with code HTTP 400 indicates that there were validation errors before attempting to connect to repository. The response will contain error messages and field errors. This response will also be sent if the repository type doesn't support connection testing.

401 - application/json [expand]

A response with code HTTP 401 indicates that the calling user had insufficient permissions, e.g. for a plan or a repository

/deploy/environment

Methods

/deploy/environment/{environmentId}/results

resource-wide template parameters

parameter	value	description
environmentId	long

Methods

GET

available response representations:

application/json [expand]

/clone

Methods

/clone/{projectKey}-{buildKey}:{toProjectKey}-{toBuildKey}

resource-wide template parameters

parameter	value	description
projectKey	string
buildKey	string
toBuildKey	string
toProjectKey	string

Methods

PUT

Method used to clone an existing Plan into a new one, possibly into different project. Usage: /rest/api/latest/clone/FROM-PLAN:TO-PLAN

available response representations:

application/xml (plan) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="plan" type="restPlan"/><xs:element name="plan" type="restPlan"/>

application/json (plan) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="plan" type="restPlan"/><xs:element name="plan" type="restPlan"/>

/plan

Plan service is supposed to be used to retrieve full list of plans and plan details

Methods

GET

Method used to list all plans on Bamboo service that user is allowed to see (READ permission). Should be invoked as /rest/api/latest/plan <p> Possible expand parameters plans - list of plans plans.plan - list of plans with plan details plans.plan.actions <p>

available response representations:

application/xml (plans) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="plans" type="restPlans"/><xs:element name="plans" type="restPlans"/>

application/json (plans) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="plans" type="restPlans"/><xs:element name="plans" type="restPlans"/>

/plan/{projectKey}-{buildKey}

resource-wide template parameters

parameter	value	description
projectKey	string
buildKey	string

Methods

GET

available response representations:

application/xml (plan) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="plan" type="restPlan"/><xs:element name="plan" type="restPlan"/>

application/json (plan) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="plan" type="restPlan"/><xs:element name="plan" type="restPlan"/>

/plan/{projectKey}/{buildKey}

resource-wide template parameters

parameter	value	description
projectKey	string
buildKey	string

Methods

GET

available response representations:

application/xml (plan) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="plan" type="restPlan"/><xs:element name="plan" type="restPlan"/>

application/json (plan) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="plan" type="restPlan"/><xs:element name="plan" type="restPlan"/>

/plan/{projectKey}-{buildKey}/branch

resource-wide template parameters

parameter	value	description
projectKey	string	project key
buildKey	string	plan key (might be simply planKey or composite planKey-jobKey)

Methods

GET

Provide list of branches for specified plan. Plan might be top level plan (projectKey-planKey) or job plan (projectKey-planKey-jobKey). You can use "enabledOnly" param to filter out disabled branches.

available response representations:

200 [expand]

List of branches in the vcs of the default repository for the given plan

401 [expand]

Returned when user has no permission to view specified plan

404 [expand]

Returned when specified project, plan does not exist

/plan/{projectKey}-{buildKey}/branch/{branchName}?vcsBranch&enabled

resource-wide template parameters

parameter	value	description
projectKey	string	project key
buildKey	string	plan key (might be simply planKey or composite planKey-jobKey)
branchName	string	branch display name

Methods

PUT

Method for creating branch for a specified plan. You can use vcsBranch query param to define which vcsBranch should newly created branch use. If not specified it will not override vcsBranch from the main plan. Example usage: curl -X PUT --user admin:admin http://localhost:8085/rest/api/latest/plan/PROJ-PLAN/branch/BranchName?vcsBranch="/refs/heads/myBranch"

request query parameters

parameter	value	description
vcsBranch	string	name of the VCS branch
enabled	boolean

available response representations:

200 [expand]

The newly created branch.

401 [expand]

Returned when user has no permission to view specified plan

404 [expand]

Returned when specified project, plan does not exist

GET

Provide details for specified Branch of a specified Plan. Plan might be top level plan (projectKey-planKey) or job plan (projectKey-planKey-jobKey).

available response representations:

200 [expand]

List of branches in the vcs of the default repository for the given plan

401 [expand]

Returned when user has no permission to view specified plan

404 [expand]

Returned when specified project, plan does not exist

/plan/{projectKey}-{buildKey}/label

resource-wide template parameters

parameter	value	description
projectKey	string	project key
buildKey	string	plan key (might be simply planKey or composite planKey-jobKey)

Methods

GET

Provide list of labels for plan specified by projectKey-buildKey.

available response representations:

200 (restPlanLabelList) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<labels>
    <labels start-index="0" max-result="2" size="0">
        <label name="someLabel"/>
        <label name="someLabel"/>
    </labels>
</labels>

List of comments for build result

XML Schema

Source:

401 [expand]

Returned when user has no permission to view specified plan

404 [expand]

Returned when specified project, plan does not exist

POST

Adds new label to plan specified by projectKey-buildKey.

acceptable request representations:

application/xml (label) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<label name="someLabel"/>

XML Schema

Source: xsd0.xsd

<xs:element name="label" nillable="true" type="xs:anyType"/><xs:element name="label" nillable="true" type="xs:anyType"/>

application/json (label) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<label name="someLabel"/>

XML Schema

Source: xsd0.xsd

<xs:element name="label" nillable="true" type="xs:anyType"/><xs:element name="label" nillable="true" type="xs:anyType"/>

/plan/{projectKey}-{buildKey}/label/{labelName}

resource-wide template parameters

parameter	value	description
projectKey	string	project key
buildKey	string	plan key (might be simply planKey or composite planKey-jobKey)
labelName	string	label name to remove from plan

Methods

DELETE

Removes label from plan specified by projectKey-buildKey-buildNumber.

/plan/{projectKey}-{buildKey}/vcsBranches

resource-wide template parameters

parameter	value	description
projectKey	string
buildKey	string

Methods

GET

Provide list of vcs branch names for branches that exist on the default repository of this plan

available response representations:

200 [expand]

List of branches in the vcs of the default repository for the given plan

401 [expand]

Returned when user has no permission to view specified plan

404 [expand]

Returned when specified project, plan does not exist

/plan/{projectKey}-{buildKey}/issue/{issueKey}

resource-wide template parameters

parameter	value	description
projectKey	string
issueKey	string
buildKey	string

Methods

GET

available response representations:

application/xml (issue) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="issue" type="restJiraIssue"/><xs:element name="issue" type="restJiraIssue"/>

application/json (issue) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="issue" type="restJiraIssue"/><xs:element name="issue" type="restJiraIssue"/>

/plan/{projectKey}-{buildKey}/favourite

resource-wide template parameters

parameter	value	description
projectKey	string
buildKey	string

Methods

POST

available response representations:

application/xml [expand]
application/json [expand]

DELETE

available response representations:

application/xml [expand]
application/json [expand]

/plan/{projectKey}-{buildKey}/enable

resource-wide template parameters

parameter	value	description
projectKey	string
buildKey	string

Methods

POST

available response representations:

application/xml [expand]
application/json [expand]

DELETE

available response representations:

application/xml [expand]
application/json [expand]

/plan/{projectKey}-{buildKey}/artifact

resource-wide template parameters

parameter	value	description
projectKey	string
buildKey	string

Methods

GET

available response representations:

application/xml (artifacts) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="artifacts" type="restArtifactDefinitions"/><xs:element name="artifacts" type="restArtifactDefinitions"/>

application/json (artifacts) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="artifacts" type="restArtifactDefinitions"/><xs:element name="artifacts" type="restArtifactDefinitions"/>

/plan/{projectKey}-{buildKey}/test/{testId}/quarantine

resource-wide template parameters

parameter	value	description
projectKey	string
buildKey	string
testId	long

Methods

POST

acceptable request representations:

application/xml (restQuarantineExpiry) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="restQuarantineExpiry" type="restQuarantineExpiry"/><xs:element name="restQuarantineExpiry" type="restQuarantineExpiry"/>

application/json (restQuarantineExpiry) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="restQuarantineExpiry" type="restQuarantineExpiry"/><xs:element name="restQuarantineExpiry" type="restQuarantineExpiry"/>

available response representations:

application/xml [expand]
application/json [expand]

/plan/{projectKey}-{buildKey}/test/{testId}/unleash

resource-wide template parameters

parameter	value	description
projectKey	string
buildKey	string
testId	long

Methods

POST

available response representations:

application/xml [expand]
application/json [expand]

/deploy/dashboard

Methods

GET

available response representations:

application/json (dashboardProjectWithEnvironmentStatus) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="dashboardProjectWithEnvironmentStatus" type="dashboardProjectWithEnvironmentStatus"/><xs:element name="dashboardProjectWithEnvironmentStatus" type="dashboardProjectWithEnvironmentStatus"/>

/deploy/dashboard/{projectId}

resource-wide template parameters

parameter	value	description
projectId	long

Methods

GET

available response representations:

application/json (dashboardProjectWithEnvironmentStatus) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="dashboardProjectWithEnvironmentStatus" type="dashboardProjectWithEnvironmentStatus"/><xs:element name="dashboardProjectWithEnvironmentStatus" type="dashboardProjectWithEnvironmentStatus"/>

/result?expand&favourite&label&issueKey&includeAllStates&continuable&buildstate&start-index&max-results

Provide build results information. Available for anonymous and authenticated users, however proper permissions are enforced

Methods

GET

Provide list of latest build results for top level plans visible for users.

request query parameters

parameter	value	description
expand	string	expands build result details on request. Possible values are: artifacts, comments, labels, jiraIssues, stages. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. All expand parameters should contain results.result prefix.
favourite	boolean	filters build results list to show only results for favourite plans. Works only for authenticated user
label	string	filter by comma separated list of labels
issueKey	string	filter by comma separated list of Jira issue key related to result
includeAllStates	boolean	return all build results including Unknown states
continuable	boolean	filter only results that may be continued (stopped on Manual Stage)
buildstate	boolean	filter results by state, valid values are Unknown, Successful, Failed
start-index	int	start index for results list (zero based)
max-results	int	maximum size for returned list

available response representations:

200 - application/xml, application/json (restResults) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<results>
    <results start-index="0" max-result="2" size="0">
        <result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="PPROJECTKEY-PLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="2" id="10000" continuable="false" onceOff="false" restartable="false">
            <planName>PLAN_NAME</planName>
            <projectName>PROJECT_NAME</projectName>
            <buildStartedTime>2016-02-08T09:26:00.531Z</buildStartedTime>
            <prettyBuildStartedTime>2016-02-08T09:26:00</prettyBuildStartedTime>
            <buildCompletedTime>2016-02-08T09:26:00.602Z</buildCompletedTime>
            <buildCompletedDate>2016-02-08T09:26:00.602Z</buildCompletedDate>
            <prettyBuildCompletedTime>2016-02-08T09:26:00</prettyBuildCompletedTime>
            <buildDurationInSeconds>1</buildDurationInSeconds>
            <buildDuration>1000</buildDuration>
            <buildDurationDescription>1 second</buildDurationDescription>
            <buildRelativeTime>1 hour ago</buildRelativeTime>
            <queueStartedTime>2016-02-08T09:26:00.602Z</queueStartedTime>
            <prettyQueueStartedTime>2016-02-08T09:26:00</prettyQueueStartedTime>
            <restartCount>0</restartCount>
            <artifacts start-index="0" max-result="1" size="0">
                <artifact>
                    <name>cargo log</name>
                    <link href="http://localhost:8085/bamboo/browse/PROJECTKEY-PLANKEY-2/artifact/shared/cargo-log.log" rel="self"/>
                    <producerJobKey>PROJECTKEY-PLANKEY-2</producerJobKey>
                    <shared>true</shared>
                    <size>1024</size>
                    <prettySizeDescription>1 kilobyte</prettySizeDescription>
                </artifact>
            </artifacts>
            <comments start-index="0" max-result="2" size="0">
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
            </comments>
            <labels start-index="0" max-result="2" size="0">
                <label name="someLabel"/>
                <label name="someLabel"/>
            </labels>
            <jiraIssues start-index="0" max-result="2" size="0">
                <issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
                </issue>
                <issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
                </issue>
            </jiraIssues>
        </result>
        <result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" state="SUCCESS" lifeCycleState="Finished" number="2" id="10000" continuable="false" onceOff="false" restartable="false">
            <planName>ANOTHER_PLAN_NAME</planName>
            <projectName>ANOTHER_PROJECT_NAME</projectName>
            <buildStartedTime>2016-02-08T09:26:00.755Z</buildStartedTime>
            <prettyBuildStartedTime>2016-02-08T09:26:00</prettyBuildStartedTime>
            <buildCompletedTime>2016-02-08T09:26:00.755Z</buildCompletedTime>
            <buildCompletedDate>2016-02-08T09:26:00.755Z</buildCompletedDate>
            <prettyBuildCompletedTime>2016-02-08T09:26:00</prettyBuildCompletedTime>
            <buildDurationInSeconds>1</buildDurationInSeconds>
            <buildDuration>1000</buildDuration>
            <buildDurationDescription>1 second</buildDurationDescription>
            <buildRelativeTime>1 hour ago</buildRelativeTime>
            <queueStartedTime>2016-02-08T09:26:00.755Z</queueStartedTime>
            <prettyQueueStartedTime>2016-02-08T09:26:00</prettyQueueStartedTime>
            <restartCount>0</restartCount>
            <comments start-index="0" max-result="2" size="0">
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
            </comments>
            <labels start-index="0" max-result="2" size="0">
                <label name="someLabel"/>
                <label name="someLabel"/>
            </labels>
            <jiraIssues start-index="0" max-result="2" size="0">
                <issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
                </issue>
                <issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
                </issue>
            </jiraIssues>
        </result>
    </results>
</results>

Latest build results for all plans

XML Schema

Source:

/result/{projectKey}-{buildKey}-{buildNumber : ([0-9]+)|(latest)}?expand&favourite&start-index&max-results

resource-wide template parameters

parameter	value	description
projectKey	string	project key
buildKey	string	plan key (might be simply planKey or composite planKey-jobKey)
buildNumber	string	either the number of the specific build result or 'latest' for the highest build number

Methods

GET

Provide build result specified by projectKey-buildKey-buildNumber. Build number may be specified as "latest" for the result with the highest build number.

request query parameters

parameter	value	description
expand	string	expands build result details on request. Possible values are: changes, metadata, artifacts, comments, labels, jiraIssues, stages, logEntries. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. logEntries and testResults are available only for job results
favourite	boolean	filters build results list to show only results for favourite plans. Works only for authenticated user
start-index	int	start index for results list (zero based)
max-results	int	maximum size for returned list

available response representations:

200 - application/xml, application/json (resultDetails) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="PPROJECTKEY-PLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="2" id="10000" continuable="false" onceOff="false" restartable="false">
    <planName>PLAN_NAME</planName>
    <projectName>PROJECT_NAME</projectName>
    <buildStartedTime>2016-02-08T09:26:00.531Z</buildStartedTime>
    <prettyBuildStartedTime>2016-02-08T09:26:00</prettyBuildStartedTime>
    <buildCompletedTime>2016-02-08T09:26:00.602Z</buildCompletedTime>
    <buildCompletedDate>2016-02-08T09:26:00.602Z</buildCompletedDate>
    <prettyBuildCompletedTime>2016-02-08T09:26:00</prettyBuildCompletedTime>
    <buildDurationInSeconds>1</buildDurationInSeconds>
    <buildDuration>1000</buildDuration>
    <buildDurationDescription>1 second</buildDurationDescription>
    <buildRelativeTime>1 hour ago</buildRelativeTime>
    <queueStartedTime>2016-02-08T09:26:00.602Z</queueStartedTime>
    <prettyQueueStartedTime>2016-02-08T09:26:00</prettyQueueStartedTime>
    <restartCount>0</restartCount>
    <artifacts start-index="0" max-result="1" size="0">
        <artifact>
            <name>cargo log</name>
            <link href="http://localhost:8085/bamboo/browse/PROJECTKEY-PLANKEY-2/artifact/shared/cargo-log.log" rel="self"/>
            <producerJobKey>PROJECTKEY-PLANKEY-2</producerJobKey>
            <shared>true</shared>
            <size>1024</size>
            <prettySizeDescription>1 kilobyte</prettySizeDescription>
        </artifact>
    </artifacts>
    <comments start-index="0" max-result="2" size="0">
        <comment author="bambooUser">
            <content>Sample comment for build</content>
            <creationDate>2016-02-08T09:26:00.603Z</creationDate>
            <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
        </comment>
        <comment author="bambooUser">
            <content>Sample comment for build</content>
            <creationDate>2016-02-08T09:26:00.603Z</creationDate>
            <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
        </comment>
    </comments>
    <labels start-index="0" max-result="2" size="0">
        <label name="someLabel"/>
        <label name="someLabel"/>
    </labels>
    <jiraIssues start-index="0" max-result="2" size="0">
        <issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
            <url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
        </issue>
        <issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
            <url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
        </issue>
    </jiraIssues>
    <changes expand="changes" start-index="0" max-result="2" size="0">
        <change expand="change" author="Author" changesetId="10">
            <comment>Sample comment</comment>
            <date>2016-02-08T09:26:00.619Z</date>
            <files start-index="0" max-result="3" size="0">
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
            </files>
        </change>
        <change expand="change" author="Author" changesetId="10">
            <comment>Sample comment</comment>
            <date>2016-02-08T09:26:00.619Z</date>
            <files start-index="0" max-result="3" size="0">
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
            </files>
        </change>
    </changes>
    <metadata start-index="0" max-result="1" size="0">
        <item key="ManualBuildTriggerReason.userName" value="admin"/>
    </metadata>
</result>

Result of single build. Presented content contain information for finished build. If build is in progress, contains additional runtime information. Top level plan contains additionally progress information, job progress information, current log entries and hasExecutableAgent boolean flag.

XML Schema

Source:

401 [expand]

Returned when user has no permission to view specified plan

404 [expand]

Returned when specified project or plan does not exists

/result/{projectKey}?expand&favourite&label&issueKey&includeAllStates&continuable&buildstate&start-index&max-results

resource-wide template parameters

parameter	value	description
projectKey	string	project key to filter plan result list

Methods

GET

Provide list of latest build results for top level plans for specified project. List of results is limited to plans visible for user.

request query parameters

parameter	value	description
expand	string	expands build result details on request. Possible values are: artifacts, comments, labels, jiraIssues, stages. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. All expand parameters should contain results.result prefix.
favourite	boolean	filters build results list to show only results for favourite plans. Works only for authenticated user
label	string	filter by comma separated list of labels
issueKey	string	filter by comma separated list of Jira issue key related to result
includeAllStates	boolean	return all build results including Unknown states
continuable	boolean	filter only results that may be continued (stopped on Manual Stage)
buildstate	boolean	filter results by state, valid values are Unknown, Successful, Failed
start-index	int	start index for results list (zero based)
max-results	int	maximum size for returned list

available response representations:

200 - application/xml, application/json (restResults) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<results>
    <results start-index="0" max-result="1" size="0">
        <result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="ANOTHERPPROJECTKEY-ANOTHERPLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="1" id="10000" continuable="false" onceOff="false" restartable="false">
            <planName>PLAN_NAME</planName>
            <projectName>PROJECT_NAME</projectName>
            <buildStartedTime>2016-02-08T09:26:00.755Z</buildStartedTime>
            <prettyBuildStartedTime>2016-02-08T09:26:00</prettyBuildStartedTime>
            <buildCompletedTime>2016-02-08T09:26:00.755Z</buildCompletedTime>
            <buildCompletedDate>2016-02-08T09:26:00.755Z</buildCompletedDate>
            <prettyBuildCompletedTime>2016-02-08T09:26:00</prettyBuildCompletedTime>
            <buildDurationInSeconds>1</buildDurationInSeconds>
            <buildDuration>1000</buildDuration>
            <buildDurationDescription>1 second</buildDurationDescription>
            <buildRelativeTime>1 hour ago</buildRelativeTime>
            <queueStartedTime>2016-02-08T09:26:00.755Z</queueStartedTime>
            <prettyQueueStartedTime>2016-02-08T09:26:00</prettyQueueStartedTime>
            <restartCount>0</restartCount>
            <comments start-index="0" max-result="2" size="0">
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
            </comments>
            <labels start-index="0" max-result="2" size="0">
                <label name="someLabel"/>
                <label name="someLabel"/>
            </labels>
            <jiraIssues start-index="0" max-result="2" size="0">
                <issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
                </issue>
                <issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
                </issue>
            </jiraIssues>
        </result>
    </results>
</results>

Latest build results for plans for specified project

XML Schema

Source:

404 [expand]

Returned when specified project does not exists or user does not have permission to see plans for specified project

/result/byChangeset/{csid}

resource-wide template parameters

parameter	value	description
csid	string	changeset id related to build result

Methods

GET

Provide list of build results related to changeset id passed as parameter. List of results contains results from all plans related to this changeset.

available response representations:

200 - application/xml, application/json (restResults) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<results>
    <results start-index="0" max-result="2" size="0">
        <result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="ANOTHERPPROJECTKEY-ANOTHERPLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="1" id="10000" continuable="false" onceOff="false" restartable="false">
            <planName>PLAN_NAME</planName>
            <projectName>PROJECT_NAME</projectName>
            <buildStartedTime>2016-02-08T09:26:00.755Z</buildStartedTime>
            <prettyBuildStartedTime>2016-02-08T09:26:00</prettyBuildStartedTime>
            <buildCompletedTime>2016-02-08T09:26:00.755Z</buildCompletedTime>
            <buildCompletedDate>2016-02-08T09:26:00.755Z</buildCompletedDate>
            <prettyBuildCompletedTime>2016-02-08T09:26:00</prettyBuildCompletedTime>
            <buildDurationInSeconds>1</buildDurationInSeconds>
            <buildDuration>1000</buildDuration>
            <buildDurationDescription>1 second</buildDurationDescription>
            <buildRelativeTime>1 hour ago</buildRelativeTime>
            <queueStartedTime>2016-02-08T09:26:00.755Z</queueStartedTime>
            <prettyQueueStartedTime>2016-02-08T09:26:00</prettyQueueStartedTime>
            <restartCount>0</restartCount>
            <comments start-index="0" max-result="2" size="0">
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
            </comments>
            <labels start-index="0" max-result="2" size="0">
                <label name="someLabel"/>
                <label name="someLabel"/>
            </labels>
            <jiraIssues start-index="0" max-result="2" size="0">
                <issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
                </issue>
                <issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
                </issue>
            </jiraIssues>
        </result>
        <result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="PPROJECTKEY-PLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="2" id="10000" continuable="false" onceOff="false" restartable="false">
            <planName>PLAN_NAME</planName>
            <projectName>PROJECT_NAME</projectName>
            <buildStartedTime>2016-02-08T09:26:00.531Z</buildStartedTime>
            <prettyBuildStartedTime>2016-02-08T09:26:00</prettyBuildStartedTime>
            <buildCompletedTime>2016-02-08T09:26:00.602Z</buildCompletedTime>
            <buildCompletedDate>2016-02-08T09:26:00.602Z</buildCompletedDate>
            <prettyBuildCompletedTime>2016-02-08T09:26:00</prettyBuildCompletedTime>
            <buildDurationInSeconds>1</buildDurationInSeconds>
            <buildDuration>1000</buildDuration>
            <buildDurationDescription>1 second</buildDurationDescription>
            <buildRelativeTime>1 hour ago</buildRelativeTime>
            <queueStartedTime>2016-02-08T09:26:00.602Z</queueStartedTime>
            <prettyQueueStartedTime>2016-02-08T09:26:00</prettyQueueStartedTime>
            <restartCount>0</restartCount>
            <artifacts start-index="0" max-result="1" size="0">
                <artifact>
                    <name>cargo log</name>
                    <link href="http://localhost:8085/bamboo/browse/PROJECTKEY-PLANKEY-2/artifact/shared/cargo-log.log" rel="self"/>
                    <producerJobKey>PROJECTKEY-PLANKEY-2</producerJobKey>
                    <shared>true</shared>
                    <size>1024</size>
                    <prettySizeDescription>1 kilobyte</prettySizeDescription>
                </artifact>
            </artifacts>
            <comments start-index="0" max-result="2" size="0">
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
            </comments>
            <labels start-index="0" max-result="2" size="0">
                <label name="someLabel"/>
                <label name="someLabel"/>
            </labels>
            <jiraIssues start-index="0" max-result="2" size="0">
                <issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
                </issue>
                <issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
                </issue>
            </jiraIssues>
        </result>
    </results>
</results>

Build results for specified changeset.

XML Schema

Source:

/result/byCheckoutChangeset/{csid}

resource-wide template parameters

parameter	value	description
csid	string	checkout changeset id related to build result

Methods

GET

Provide list of build results related to changeset id passed as parameter. List of results contains results from all plans which have repositories checked out with this changeset.

available response representations:

200 - application/xml, application/json (restResults) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<results>
    <results start-index="0" max-result="2" size="0">
        <result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="ANOTHERPPROJECTKEY-ANOTHERPLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="1" id="10000" continuable="false" onceOff="false" restartable="false">
            <planName>PLAN_NAME</planName>
            <projectName>PROJECT_NAME</projectName>
            <buildStartedTime>2016-02-08T09:26:00.755Z</buildStartedTime>
            <prettyBuildStartedTime>2016-02-08T09:26:00</prettyBuildStartedTime>
            <buildCompletedTime>2016-02-08T09:26:00.755Z</buildCompletedTime>
            <buildCompletedDate>2016-02-08T09:26:00.755Z</buildCompletedDate>
            <prettyBuildCompletedTime>2016-02-08T09:26:00</prettyBuildCompletedTime>
            <buildDurationInSeconds>1</buildDurationInSeconds>
            <buildDuration>1000</buildDuration>
            <buildDurationDescription>1 second</buildDurationDescription>
            <buildRelativeTime>1 hour ago</buildRelativeTime>
            <queueStartedTime>2016-02-08T09:26:00.755Z</queueStartedTime>
            <prettyQueueStartedTime>2016-02-08T09:26:00</prettyQueueStartedTime>
            <restartCount>0</restartCount>
            <comments start-index="0" max-result="2" size="0">
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
            </comments>
            <labels start-index="0" max-result="2" size="0">
                <label name="someLabel"/>
                <label name="someLabel"/>
            </labels>
            <jiraIssues start-index="0" max-result="2" size="0">
                <issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
                </issue>
                <issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
                </issue>
            </jiraIssues>
        </result>
        <result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="PPROJECTKEY-PLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="2" id="10000" continuable="false" onceOff="false" restartable="false">
            <planName>PLAN_NAME</planName>
            <projectName>PROJECT_NAME</projectName>
            <buildStartedTime>2016-02-08T09:26:00.531Z</buildStartedTime>
            <prettyBuildStartedTime>2016-02-08T09:26:00</prettyBuildStartedTime>
            <buildCompletedTime>2016-02-08T09:26:00.602Z</buildCompletedTime>
            <buildCompletedDate>2016-02-08T09:26:00.602Z</buildCompletedDate>
            <prettyBuildCompletedTime>2016-02-08T09:26:00</prettyBuildCompletedTime>
            <buildDurationInSeconds>1</buildDurationInSeconds>
            <buildDuration>1000</buildDuration>
            <buildDurationDescription>1 second</buildDurationDescription>
            <buildRelativeTime>1 hour ago</buildRelativeTime>
            <queueStartedTime>2016-02-08T09:26:00.602Z</queueStartedTime>
            <prettyQueueStartedTime>2016-02-08T09:26:00</prettyQueueStartedTime>
            <restartCount>0</restartCount>
            <artifacts start-index="0" max-result="1" size="0">
                <artifact>
                    <name>cargo log</name>
                    <link href="http://localhost:8085/bamboo/browse/PROJECTKEY-PLANKEY-2/artifact/shared/cargo-log.log" rel="self"/>
                    <producerJobKey>PROJECTKEY-PLANKEY-2</producerJobKey>
                    <shared>true</shared>
                    <size>1024</size>
                    <prettySizeDescription>1 kilobyte</prettySizeDescription>
                </artifact>
            </artifacts>
            <comments start-index="0" max-result="2" size="0">
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
            </comments>
            <labels start-index="0" max-result="2" size="0">
                <label name="someLabel"/>
                <label name="someLabel"/>
            </labels>
            <jiraIssues start-index="0" max-result="2" size="0">
                <issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
                </issue>
                <issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
                </issue>
            </jiraIssues>
        </result>
    </results>
</results>

Build results for specified changeset.

XML Schema

Source:

/result/{projectKey}-{buildKey}?expand&favourite&label&issueKey&includeAllStates&continuable&buildstate&start-index&max-results

resource-wide template parameters

parameter	value	description
projectKey	string	project key
buildKey	string	plan key (might be simply planKey or composite planKey-jobKey)

Methods

GET

Provide list of build results for specified plan. Plan might be top level plan (projectKey-planKey) or job plan (projectKey-planKey-jobKey).

request query parameters

parameter	value	description
expand	string	expands build result details on request. Possible values are: artifacts, comments, labels, jiraIssues, stages. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. All expand parameters should contain results.result prefix.
favourite	boolean	filters build results list to show only results for favourite plans. Works only for authenticated user
label	string	filter by comma separated list of labels
issueKey	string	filter by comma separated list of Jira issue key related to result
includeAllStates	boolean	return all build results including Unknown states
continuable	boolean	filter only results that may be continued (stopped on Manual Stage)
buildstate	boolean	filter results by state, valid values are Unknown, Successful, Failed
start-index	int	start index for results list (zero based)
max-results	int	maximum size for returned list

available response representations:

200 - application/xml, application/json (restResults) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<results>
    <results start-index="0" max-result="2" size="0">
        <result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="ANOTHERPPROJECTKEY-ANOTHERPLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="1" id="10000" continuable="false" onceOff="false" restartable="false">
            <planName>PLAN_NAME</planName>
            <projectName>PROJECT_NAME</projectName>
            <buildStartedTime>2016-02-08T09:26:00.755Z</buildStartedTime>
            <prettyBuildStartedTime>2016-02-08T09:26:00</prettyBuildStartedTime>
            <buildCompletedTime>2016-02-08T09:26:00.755Z</buildCompletedTime>
            <buildCompletedDate>2016-02-08T09:26:00.755Z</buildCompletedDate>
            <prettyBuildCompletedTime>2016-02-08T09:26:00</prettyBuildCompletedTime>
            <buildDurationInSeconds>1</buildDurationInSeconds>
            <buildDuration>1000</buildDuration>
            <buildDurationDescription>1 second</buildDurationDescription>
            <buildRelativeTime>1 hour ago</buildRelativeTime>
            <queueStartedTime>2016-02-08T09:26:00.755Z</queueStartedTime>
            <prettyQueueStartedTime>2016-02-08T09:26:00</prettyQueueStartedTime>
            <restartCount>0</restartCount>
            <comments start-index="0" max-result="2" size="0">
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
            </comments>
            <labels start-index="0" max-result="2" size="0">
                <label name="someLabel"/>
                <label name="someLabel"/>
            </labels>
            <jiraIssues start-index="0" max-result="2" size="0">
                <issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
                </issue>
                <issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
                </issue>
            </jiraIssues>
        </result>
        <result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="PPROJECTKEY-PLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="2" id="10000" continuable="false" onceOff="false" restartable="false">
            <planName>PLAN_NAME</planName>
            <projectName>PROJECT_NAME</projectName>
            <buildStartedTime>2016-02-08T09:26:00.531Z</buildStartedTime>
            <prettyBuildStartedTime>2016-02-08T09:26:00</prettyBuildStartedTime>
            <buildCompletedTime>2016-02-08T09:26:00.602Z</buildCompletedTime>
            <buildCompletedDate>2016-02-08T09:26:00.602Z</buildCompletedDate>
            <prettyBuildCompletedTime>2016-02-08T09:26:00</prettyBuildCompletedTime>
            <buildDurationInSeconds>1</buildDurationInSeconds>
            <buildDuration>1000</buildDuration>
            <buildDurationDescription>1 second</buildDurationDescription>
            <buildRelativeTime>1 hour ago</buildRelativeTime>
            <queueStartedTime>2016-02-08T09:26:00.602Z</queueStartedTime>
            <prettyQueueStartedTime>2016-02-08T09:26:00</prettyQueueStartedTime>
            <restartCount>0</restartCount>
            <artifacts start-index="0" max-result="1" size="0">
                <artifact>
                    <name>cargo log</name>
                    <link href="http://localhost:8085/bamboo/browse/PROJECTKEY-PLANKEY-2/artifact/shared/cargo-log.log" rel="self"/>
                    <producerJobKey>PROJECTKEY-PLANKEY-2</producerJobKey>
                    <shared>true</shared>
                    <size>1024</size>
                    <prettySizeDescription>1 kilobyte</prettySizeDescription>
                </artifact>
            </artifacts>
            <comments start-index="0" max-result="2" size="0">
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
            </comments>
            <labels start-index="0" max-result="2" size="0">
                <label name="someLabel"/>
                <label name="someLabel"/>
            </labels>
            <jiraIssues start-index="0" max-result="2" size="0">
                <issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
                </issue>
                <issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
                </issue>
            </jiraIssues>
        </result>
    </results>
</results>

Latest build results for specified plan. Results are ordered from latest or oldest.

XML Schema

Source:

401 [expand]

Returned when user has no permission to view specified plan

404 [expand]

Returned when specified project or plan does not exists

/result/{projectKey}-{buildKey}/branch/{branchName}?expand&favourite&label&issueKey&includeAllStates&continuable&buildstate&start-index&max-results

resource-wide template parameters

parameter	value	description
projectKey	string
buildKey	string
branchName	string

Methods

GET

Provide list of build results for specified plan. Plan might be top level plan (projectKey-planKey) or job plan (projectKey-planKey-jobKey).

request query parameters

parameter	value	description
expand	string
favourite	boolean
label	string
issueKey	string
includeAllStates	boolean
continuable	boolean
buildstate	boolean
start-index	int
max-results	int

available response representations:

200 - application/xml, application/json (restResults) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<results>
    <results start-index="0" max-result="2" size="0">
        <result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="ANOTHERPPROJECTKEY-ANOTHERPLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="1" id="10000" continuable="false" onceOff="false" restartable="false">
            <planName>PLAN_NAME</planName>
            <projectName>PROJECT_NAME</projectName>
            <buildStartedTime>2016-02-08T09:26:00.755Z</buildStartedTime>
            <prettyBuildStartedTime>2016-02-08T09:26:00</prettyBuildStartedTime>
            <buildCompletedTime>2016-02-08T09:26:00.755Z</buildCompletedTime>
            <buildCompletedDate>2016-02-08T09:26:00.755Z</buildCompletedDate>
            <prettyBuildCompletedTime>2016-02-08T09:26:00</prettyBuildCompletedTime>
            <buildDurationInSeconds>1</buildDurationInSeconds>
            <buildDuration>1000</buildDuration>
            <buildDurationDescription>1 second</buildDurationDescription>
            <buildRelativeTime>1 hour ago</buildRelativeTime>
            <queueStartedTime>2016-02-08T09:26:00.755Z</queueStartedTime>
            <prettyQueueStartedTime>2016-02-08T09:26:00</prettyQueueStartedTime>
            <restartCount>0</restartCount>
            <comments start-index="0" max-result="2" size="0">
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
            </comments>
            <labels start-index="0" max-result="2" size="0">
                <label name="someLabel"/>
                <label name="someLabel"/>
            </labels>
            <jiraIssues start-index="0" max-result="2" size="0">
                <issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
                </issue>
                <issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
                </issue>
            </jiraIssues>
        </result>
        <result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="PPROJECTKEY-PLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="2" id="10000" continuable="false" onceOff="false" restartable="false">
            <planName>PLAN_NAME</planName>
            <projectName>PROJECT_NAME</projectName>
            <buildStartedTime>2016-02-08T09:26:00.531Z</buildStartedTime>
            <prettyBuildStartedTime>2016-02-08T09:26:00</prettyBuildStartedTime>
            <buildCompletedTime>2016-02-08T09:26:00.602Z</buildCompletedTime>
            <buildCompletedDate>2016-02-08T09:26:00.602Z</buildCompletedDate>
            <prettyBuildCompletedTime>2016-02-08T09:26:00</prettyBuildCompletedTime>
            <buildDurationInSeconds>1</buildDurationInSeconds>
            <buildDuration>1000</buildDuration>
            <buildDurationDescription>1 second</buildDurationDescription>
            <buildRelativeTime>1 hour ago</buildRelativeTime>
            <queueStartedTime>2016-02-08T09:26:00.602Z</queueStartedTime>
            <prettyQueueStartedTime>2016-02-08T09:26:00</prettyQueueStartedTime>
            <restartCount>0</restartCount>
            <artifacts start-index="0" max-result="1" size="0">
                <artifact>
                    <name>cargo log</name>
                    <link href="http://localhost:8085/bamboo/browse/PROJECTKEY-PLANKEY-2/artifact/shared/cargo-log.log" rel="self"/>
                    <producerJobKey>PROJECTKEY-PLANKEY-2</producerJobKey>
                    <shared>true</shared>
                    <size>1024</size>
                    <prettySizeDescription>1 kilobyte</prettySizeDescription>
                </artifact>
            </artifacts>
            <comments start-index="0" max-result="2" size="0">
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
                <comment author="bambooUser">
                    <content>Sample comment for build</content>
                    <creationDate>2016-02-08T09:26:00.603Z</creationDate>
                    <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
                </comment>
            </comments>
            <labels start-index="0" max-result="2" size="0">
                <label name="someLabel"/>
                <label name="someLabel"/>
            </labels>
            <jiraIssues start-index="0" max-result="2" size="0">
                <issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
                </issue>
                <issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
                    <url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
                </issue>
            </jiraIssues>
        </result>
    </results>
</results>

Latest build results for specified plan. Results are ordered from latest or oldest.

XML Schema

Source:

401 [expand]

Returned when user has no permission to view specified plan

404 [expand]

Returned when specified project or plan does not exists

/result/{projectKey}-{buildKey}/{buildNumber : ([0-9]+)|(latest)}?expand&favourite&start-index&max-results

resource-wide template parameters

parameter	value	description
projectKey	string	project key
buildKey	string	plan key (might be simply planKey or composite planKey-jobKey)
buildNumber	string	either the number of the specific build result or 'latest' for the highest build number

Methods

GET

Provide build result specified by projectKey-buildKey-buildNumber. Build number may be specified as "latest" for the result with the highest build number.

request query parameters

parameter	value	description
expand	string	expands build result details on request. Possible values are: changes, metadata, artifacts, comments, labels, jiraIssues, stages, logEntries. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. logEntries and testResults are available only for job results
favourite	boolean	filters build results list to show only results for favourite plans. Works only for authenticated user
start-index	int	start index for results list (zero based)
max-results	int	maximum size for returned list

available response representations:

200 - application/xml, application/json (resultDetails) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="PPROJECTKEY-PLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="2" id="10000" continuable="false" onceOff="false" restartable="false">
    <planName>PLAN_NAME</planName>
    <projectName>PROJECT_NAME</projectName>
    <buildStartedTime>2016-02-08T09:26:00.531Z</buildStartedTime>
    <prettyBuildStartedTime>2016-02-08T09:26:00</prettyBuildStartedTime>
    <buildCompletedTime>2016-02-08T09:26:00.602Z</buildCompletedTime>
    <buildCompletedDate>2016-02-08T09:26:00.602Z</buildCompletedDate>
    <prettyBuildCompletedTime>2016-02-08T09:26:00</prettyBuildCompletedTime>
    <buildDurationInSeconds>1</buildDurationInSeconds>
    <buildDuration>1000</buildDuration>
    <buildDurationDescription>1 second</buildDurationDescription>
    <buildRelativeTime>1 hour ago</buildRelativeTime>
    <queueStartedTime>2016-02-08T09:26:00.602Z</queueStartedTime>
    <prettyQueueStartedTime>2016-02-08T09:26:00</prettyQueueStartedTime>
    <restartCount>0</restartCount>
    <artifacts start-index="0" max-result="1" size="0">
        <artifact>
            <name>cargo log</name>
            <link href="http://localhost:8085/bamboo/browse/PROJECTKEY-PLANKEY-2/artifact/shared/cargo-log.log" rel="self"/>
            <producerJobKey>PROJECTKEY-PLANKEY-2</producerJobKey>
            <shared>true</shared>
            <size>1024</size>
            <prettySizeDescription>1 kilobyte</prettySizeDescription>
        </artifact>
    </artifacts>
    <comments start-index="0" max-result="2" size="0">
        <comment author="bambooUser">
            <content>Sample comment for build</content>
            <creationDate>2016-02-08T09:26:00.603Z</creationDate>
            <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
        </comment>
        <comment author="bambooUser">
            <content>Sample comment for build</content>
            <creationDate>2016-02-08T09:26:00.603Z</creationDate>
            <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
        </comment>
    </comments>
    <labels start-index="0" max-result="2" size="0">
        <label name="someLabel"/>
        <label name="someLabel"/>
    </labels>
    <jiraIssues start-index="0" max-result="2" size="0">
        <issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
            <url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
        </issue>
        <issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved">
            <url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
        </issue>
    </jiraIssues>
    <changes expand="changes" start-index="0" max-result="2" size="0">
        <change expand="change" author="Author" changesetId="10">
            <comment>Sample comment</comment>
            <date>2016-02-08T09:26:00.619Z</date>
            <files start-index="0" max-result="3" size="0">
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
            </files>
        </change>
        <change expand="change" author="Author" changesetId="10">
            <comment>Sample comment</comment>
            <date>2016-02-08T09:26:00.619Z</date>
            <files start-index="0" max-result="3" size="0">
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
                <file>
                    <name>some/example/path/to/File.java</name>
                    <revision>10</revision>
                </file>
            </files>
        </change>
    </changes>
    <metadata start-index="0" max-result="1" size="0">
        <item key="ManualBuildTriggerReason.userName" value="admin"/>
    </metadata>
</result>

Result of single build. Presented content contain information for finished build. If build is in progress, contains additional runtime information. Top level plan contains additionally progress information, job progress information, current log entries and hasExecutableAgent boolean flag.

XML Schema

Source:

401 [expand]

Returned when user has no permission to view specified plan

404 [expand]

Returned when specified project or plan does not exists

/result/{projectKey}-{buildKey}-{buildNumber}/comment

resource-wide template parameters

parameter	value	description
projectKey	string	project key
buildKey	string	plan key (might be simply planKey or composite planKey-jobKey)
buildNumber	string	build number

Methods

GET

Provide list of comments for build result specified by projectKey-buildKey-buildNumber. Build number may be specified as "latest" for the result with the highest build number.

available response representations:

200 - application/xml, application/json (restCommentList) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<comments>
    <comments start-index="0" max-result="2" size="0">
        <comment author="bambooUser">
            <content>Sample comment for build</content>
            <creationDate>2016-02-08T09:26:00.603Z</creationDate>
            <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
        </comment>
        <comment author="bambooUser">
            <content>Sample comment for build</content>
            <creationDate>2016-02-08T09:26:00.603Z</creationDate>
            <modificationDate>2016-02-08T09:26:00.603Z</modificationDate>
        </comment>
    </comments>
</comments>

List of comments for build result

XML Schema

Source: xsd0.xsd

<xs:element name="restCommentList" type="restCommentList"/><xs:element name="restCommentList" type="restCommentList"/>

401 [expand]

Returned when user has no permission to view specified plan

404 [expand]

Returned when specified project, plan or build result does not exists

POST

Adds new comment to build result specified by projectKey-buildKey-buildNumber.

acceptable request representations:

application/xml (comment) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<comment>
    <content>new comment content</content>
</comment>

XML Schema

Source: xsd0.xsd

<xs:element name="comment" type="restComment"/><xs:element name="comment" type="restComment"/>

application/json (comment) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<comment>
    <content>new comment content</content>
</comment>

XML Schema

Source: xsd0.xsd

<xs:element name="comment" type="restComment"/><xs:element name="comment" type="restComment"/>

/result/{projectKey}-{buildKey}-{buildNumber}/label

resource-wide template parameters

parameter	value	description
projectKey	string	project key
buildKey	string	plan key (might be simply planKey or composite planKey-jobKey)
buildNumber	string	either the number of the specific build result or 'latest' for the highest build number

Methods

GET

Provide list of labels for build result specified by projectKey-buildKey-buildNumber. Build number may be specified as "latest" for the result with the highest build number.

available response representations:

200 (restBuildLabelList) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<labels>
    <labels start-index="0" max-result="2" size="0">
        <label name="someLabel"/>
        <label name="someLabel"/>
    </labels>
</labels>

List of comments for build result

XML Schema

Source: xsd0.xsd

<xs:element name="restBuildLabelList" type="restBuildLabelList"/><xs:element name="restBuildLabelList" type="restBuildLabelList"/>

401 [expand]

Returned when user has no permission to view specified plan

404 [expand]

Returned when specified project, plan or build result does not exists

POST

Adds new label to build result specified by projectKey-buildKey-buildNumber. Build number may be specified as "latest" for the result with the highest build number.

acceptable request representations:

application/xml (label) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<label name="someLabel"/>

XML Schema

Source: xsd0.xsd

<xs:element name="label" nillable="true" type="xs:anyType"/><xs:element name="label" nillable="true" type="xs:anyType"/>

application/json (label) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<label name="someLabel"/>

XML Schema

Source: xsd0.xsd

<xs:element name="label" nillable="true" type="xs:anyType"/><xs:element name="label" nillable="true" type="xs:anyType"/>

/result/{projectKey}-{buildKey}-{buildNumber}/label/{labelName}

resource-wide template parameters

parameter	value	description
projectKey	string	project key
buildKey	string	plan key (might be simply planKey or composite planKey-jobKey)
labelName	string	label name to remove from build result
buildNumber	string	either the number of the specific build result or 'latest' for the highest build number

Methods

DELETE

Removes label from build result specified by projectKey-buildKey-buildNumber. Build number may be specified as "latest" for the result with the highest build number.

/result/status/{projectKey}-{buildKey}-{buildNumber : ([0-9]+)}

resource-wide template parameters

parameter	value	description
projectKey	string	project key
buildKey	string	plan key (might be simply planKey or composite planKey-jobKey)
buildNumber	string	buildNumber (numeric value only, 'latest' keyword is not supported for this method)

Methods

GET

Provide runtime information for currently executing build result. The key difference to other methods is that method is optimized to provide information available in memory only, so no database calls are made. The information provided is not as wide as for finished results, but the call is optimized for speed.

available response representations:

200 (restResultStatus) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<status expand="stages" key="PROJECTKEY-PLANKEY-100">
    <finished>false</finished>
    <prettyQueuedTime>2016-02-08T09:26:01</prettyQueuedTime>
    <progress>
        <isValid>true</isValid>
        <isUnderAverageTime>true</isUnderAverageTime>
        <percentageCompleted>0.4669655761516365</percentageCompleted>
        <percentageCompletedPretty>46%</percentageCompletedPretty>
        <prettyTimeRemaining>Approximately 2 minutes remaining</prettyTimeRemaining>
        <prettyTimeRemainingLong>Approximately 2 minutes remaining</prettyTimeRemainingLong>
        <averageBuildDuration>120000</averageBuildDuration>
        <prettyAverageBuildDuration>2 mins</prettyAverageBuildDuration>
        <buildTime>60000</buildTime>
        <prettyBuildTime>1 min</prettyBuildTime>
    </progress>
    <currentStage>first stage</currentStage>
    <stages expand="stage" start-index="0" max-result="1" size="0">
        <stage>
            <results expand="results" start-index="0" max-result="1" size="0">
                <result expand="result" state="Unknown">
                    <progress>
                        <isValid>true</isValid>
                        <isUnderAverageTime>true</isUnderAverageTime>
                        <percentageCompleted>0.4669655761516365</percentageCompleted>
                        <percentageCompletedPretty>46%</percentageCompletedPretty>
                        <prettyTimeRemaining>Approximately 2 minutes remaining</prettyTimeRemaining>
                        <prettyTimeRemainingLong>Approximately 2 minutes remaining</prettyTimeRemainingLong>
                        <averageBuildDuration>120000</averageBuildDuration>
                        <prettyAverageBuildDuration>2 mins</prettyAverageBuildDuration>
                        <buildTime>60000</buildTime>
                        <prettyBuildTime>1 min</prettyBuildTime>
                    </progress>
                    <waiting>false</waiting>
                    <queued>false</queued>
                    <updatingSource>false</updatingSource>
                    <prettyVcsUpdateDuration>10 seconds</prettyVcsUpdateDuration>
                </result>
            </results>
            <name>stageName</name>
            <description>stage description</description>
            <isBuilding>true</isBuilding>
            <isCompleted>false</isCompleted>
            <isSuccessful>false</isSuccessful>
            <index>0</index>
        </stage>
    </stages>
</status>

Currently executing build status

XML Schema

Source:

401 [expand]

Returned when user has no permission to view specified plan

404 [expand]

Returned when specified project, plan or build result does not exists. Also when build result is not currently executed ie. build has been completed already

/dependency

Methods

/dependency/search/{projectKey}-{buildKey}/parent?searchTerm

resource-wide template parameters

parameter	value	description
projectKey	string
buildKey	string

Methods

GET

Search for available plan parent dependencies

request query parameters

parameter	value	description
searchTerm	string

available response representations:

application/xml (dependencies) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="dependencies" type="restDependencies"/><xs:element name="dependencies" type="restDependencies"/>

application/json (dependencies) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="dependencies" type="restDependencies"/><xs:element name="dependencies" type="restDependencies"/>

/dependency/{projectKey}-{buildKey}/child

resource-wide template parameters

parameter	value	description
projectKey	string
buildKey	string

Methods

GET

List of plan child dependencies

available response representations:

application/xml (dependencies) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="dependencies" type="restDependencies"/><xs:element name="dependencies" type="restDependencies"/>

application/json (dependencies) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="dependencies" type="restDependencies"/><xs:element name="dependencies" type="restDependencies"/>

/dependency/{projectKey}-{buildKey}/parent

resource-wide template parameters

parameter	value	description
projectKey	string
buildKey	string

Methods

GET

List of plan parent dependencies

available response representations:

application/xml (dependencies) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="dependencies" type="restDependencies"/><xs:element name="dependencies" type="restDependencies"/>

application/json (dependencies) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="dependencies" type="restDependencies"/><xs:element name="dependencies" type="restDependencies"/>

/dependency/search/{projectKey}-{buildKey}/child?searchTerm

resource-wide template parameters

parameter	value	description
projectKey	string
buildKey	string

Methods

GET

Search for available plan child dependencies

request query parameters

parameter	value	description
searchTerm	string

available response representations:

application/xml (dependencies) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="dependencies" type="restDependencies"/><xs:element name="dependencies" type="restDependencies"/>

application/json (dependencies) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="dependencies" type="restDependencies"/><xs:element name="dependencies" type="restDependencies"/>

/

Directory resource for Bamboo REST resources

Methods

GET

Provides list of available REST resources in Bamboo

available response representations:

200 - application/xml, application/json (restResources) [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<resources>
    <resources start-index="0" max-result="0" size="0">
        <resource name="info">
            <link href="http://localhost:8085/bamboo/rest/api/latest/info" rel="self"/>
        </resource>
        <resource name="project">
            <link href="http://localhost:8085/bamboo/rest/api/latest/project" rel="self"/>
        </resource>
        <resource name="plan">
            <link href="http://localhost:8085/bamboo/rest/api/latest/plan" rel="self"/>
        </resource>
        <resource name="result">
            <link href="http://localhost:8085/bamboo/rest/api/latest/result" rel="self"/>
        </resource>
        <resource name="chart">
            <link href="http://localhost:8085/bamboo/rest/api/latest/chart" rel="self"/>
        </resource>
        <resource name="queue">
            <link href="http://localhost:8085/bamboo/rest/api/latest/queue" rel="self"/>
        </resource>
        <resource name="export">
            <link href="http://localhost:8085/bamboo/rest/api/latest/export" rel="self"/>
        </resource>
        <resource name="clone">
            <link href="http://localhost:8085/bamboo/rest/api/latest/clone" rel="self"/>
        </resource>
        <resource name="currentUser">
            <link href="http://localhost:8085/bamboo/rest/api/latest/currentUser" rel="self"/>
        </resource>
    </resources>
</resources>

List of available REST resources

XML Schema

Source:

/reindex?indexer

REST resource for starting/stopping/querying indexing.

Methods

POST

Kicks off a reindex. Requires system admin permissions to perform this reindex.

request query parameters

parameter	value	description
indexer	string

available response representations:

202 - application/json [expand]

Returns status of the current indexing operation

GET

Returns status of the current indexing operation. reindexInProgress - reindex is currently performed in background reindexPending - reindex is required (i.e. it failed before or some upgrade task asked for it)

available response representations:

200 - application/json [expand]

Returns status of the current indexing operation

/elasticInstances

Methods

/elasticInstances/instance/{instanceId}/logs

resource-wide template parameters

parameter	value	description
instanceId	string	id of the EC2 instance

Methods

GET

Obtain logs from an EC2 instance. Note that this method will return the console output of the instance, not Bamboo agent logs.

available response representations:

200 - application/json [expand]

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<elasticInstanceLog>
    <instanceId>i-b8532d45</instanceId>
    <log>Transaction Summary
================================================================================
Upgrade 5 Packages

Total download size: 67 M
Downloading packages:
--------------------------------------------------------------------------------</log>
</elasticInstanceLog>

A JSON object containing the instance id and it's console output

400 - application/json [expand]

Returned when input or server state validation fails, for example when AWS account is not configured or Elastic Bamboo is not enabled.

404 - application/json [expand]

Returned when no EC2 instance with the given id was found. The instance has to exist and must be managed by this Bamboo server.

/info

Methods

GET

available response representations:

application/xml (info) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="info" type="restInfo"/><xs:element name="info" type="restInfo"/>

application/json (info) [expand]

XML Schema

Source: xsd0.xsd

<xs:element name="info" type="restInfo"/><xs:element name="info" type="restInfo"/>

Bamboo REST API documentation

Introduction to Bamboo's REST APIs

Getting Started

Advanced Topics

How to use expansion in the REST APIs

Resources List

Resources

/deploy/result

Methods

/deploy/result/{deploymentResultId}?includeLogs

resource-wide template parameters

Methods

GET

request query parameters

XML Schema

/capability

Methods

/capability/groupedListing?searchTerm&lastGroup

Methods

GET

request query parameters

/project

Methods

GET

XML Schema

XML Schema

/project/{projectKey}

resource-wide template parameters

Methods

GET

XML Schema

XML Schema

/search

Methods

/search/users?searchTerm&includeAvatars

Methods

GET

request query parameters

Example

XML Schema

/search/authors?searchTerm&unlinkedOnly

Methods

GET

request query parameters

Example

XML Schema

/search/plans?searchTerm

Methods

GET

request query parameters

XML Schema

XML Schema

/search/jobs/{planKey}?searchTerm

resource-wide template parameters

Methods

GET

request query parameters

XML Schema

XML Schema

/search/stages/{planKey}?stageId&searchTerm

resource-wide template parameters

Methods

GET

request query parameters

XML Schema

XML Schema

/search/branches?masterPlanKey&includeMasterBranch&releasedInDeployment&searchTerm

Methods

GET

request query parameters

XML Schema

XML Schema

/search/projects?searchTerm

Methods

GET

request query parameters

XML Schema

XML Schema

/search/versions?searchTerm&deploymentProjectId&branchKey&chronologicalOrder

Methods