Bamboo REST API documentation

The Bamboo REST APIs are for developers who want to integrate their application with Bamboo and for administrators who want to script interactions with the Bamboo server.

Introduction to Bamboo's REST APIs

Bamboo's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. By default, the response format is XML. If you wish, you can request JSON instead of XML.

Because the REST API is based on open standards, you can use any web development language to access the API.

A common use case would be a build service, which provides information about build results.

Bamboo's REST APIs provide the following capabilities:

Getting Started

If you would like to know more about REST in general, start with the RESTwiki's guide to REST In Plain English.

Then jump right in and try our REST resources:

Advanced Topics

Below are some links to in-depth information on development of REST APIs and plugins:

How to use expansion in the REST APIs

In order to be minimise network traffic from the client perspective, our API uses a technique called expansion.

You can use the 'expand' query parameter to specify a comma-separated list of entities that you want expanded, identifying each entity by a given identifier. For example, the value "changes,stages.stage.results.result" requests the expansion of entities for which the expand identifier is "change" and "stages".

To discover the identifiers for each entity, look at the 'expand' attribute in the parent entity. In the XML example below, the page entity declares changes, metadata, artifacts, comments, labels, jiraIssues and stages as being expandable.

Note: The 'expand' attribute should not be confused with the 'expand' query parameter which specifies which entities you want expanded.

You can use the dot notation to specify expansion of entities within another entity. For example "children.children" would expand the children and the children's children (because its expand identifier is children) and the child entities within the plugin.

If not otherwise indicated, all methods return both XML and JSON. Below are examples of the XML and JSON representations.

XML representation:

[expand]
<result id="2818060" expand="changes,testResults, metadata, logEntries,artifacts,comments, labels,jiraIssues" number="11"> lifeCycleState="Finished" state="Successful"  key="PROJECTKEY-PLANKEY-JOB1-11"

<link rel="self" href="http://localhost:8085/bamboo/rest/api/latest/result/PROJECTKEY-PLANKEY-JOB1-11"/>

<parent rel="parent" href="http://localhost:8085/bamboo/rest/api/latest/result/PROJECTKEY-PLANKEY-11"/>

<planName>My plan</planName>

<projectName>My project</projectName>

<stage>Default Stage</stage>

</result>

The same content in JSON:
[expand]
{id:"2818060",
expand:"changes,testResults, metadata, logEntries,artifacts,comments, labels,jiraIssues",
number:"11"
lifeCycleState:"Finished"
state:"Successful"
key:"PROJECT_KEY-PLANKEY-JOB1-11"
link:[{href:"http://localhost:8085/bamboo/rest/api/latest/result/PROJECTKEY-PLANKEY-JOB1-11",rel:"self"}],
parent:[{href:"http://localhost:8085/bamboo/rest/api/latest/result/PROJECTKEY-PLANKEY-11",rel:"parent"}],
planName:"My plan",
projectName:"My project",
stage:"Default Stage}}

Resources List

This document the current REST API provided by Bamboo.

Resources

/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:

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

/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.

/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:

/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"/>

/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"/>

/queue/deployment?expand

Methods

GET

Provide list of deployment results scheduled for execution and waiting in queue.

request query parameters
parameter value description

expand

string

expands deployment result queue items on request. Possible value: queuedDeployments.

available response representations:

  • 200 - application/json (restQueuedDeployments) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <queue expand="queuedDeployments">
        <queuedDeployments start-index="0" max-result="2" size="0">
            <queuedDeployments>
                <deploymentResultId>12</deploymentResultId>
            </queuedDeployments>
            <queuedDeployments>
                <deploymentResultId>25</deploymentResultId>
            </queuedDeployments>
        </queuedDeployments>
    </queue>
    

    XML Schema

    Source:

POST

Trigger deployment for deployment environment and version.

request query parameters
parameter value description

environmentId

long

Deployment environment id. Mandatory

versionId

long

Version (release) id. Mandatory

available response representations:

  • 200 - application/json (restQueuedDeployment) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <restQueuedDeployment>
        <deploymentResultId>12</deploymentResultId>
    </restQueuedDeployment>
    

    Trigger deployment for environment and version

    XML Schema

    Source:

  • 400 - application/json (restValidationError) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <errors>
        <errors>Deployment environment with id 1 and deployment version with id 2 are from different deployment projects</errors>
        <fieldErrors/>
    </errors>
    

    Validation error occurred or deployment can't be triggered

    XML Schema

    Source:

  • 403 - application/json [expand]

    User don't have permissions to trigger deployment to given environment

  • 404 [expand]

    Environment or version are not found

/queue/deployment/{deploymentResultId}

resource-wide template parameters
parameter value description

deploymentResultId

long

id of deployment result in queue.

Methods

DELETE

Remove deployment result from queue.

available response representations:

  • 400 - application/json (restValidationError) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <errors>
        <errors>Deployment can't be removed from queue as it's in finished state</errors>
        <fieldErrors/>
    </errors>
    

    Deployment already finished and can't be removed from queue

    XML Schema

    Source:

  • 204 [expand]

    Successfully removed deployment result from queue

  • 403 - application/json [expand]

    User don't have permission to delete deployment from queue

  • 404 [expand]

    Can't find deployment result by deploymentResultId

/dependency

Methods

/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"/>

/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"/>

/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:

/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"/>

/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.

/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-06-16T08:58:39.649Z</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-06-16T08:58:39.649Z</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-06-16T08:58:39.649Z</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-06-16T08:58:39.649Z</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-06-16T08:58:39.649Z</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-06-16T08:58:39.649Z</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

/deploy/version

Methods

/deploy/version/{deploymentVersionId}/status

resource-wide template parameters
parameter value description

deploymentVersionId

long

deployment version id

Methods

GET

Get current status of deployment version.

available response representations:

  • 200 - application/json (restDeploymentVersionStatus) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <deploymentVersionStatus>
        <id>1</id>
        <userName>admin</userName>
        <displayName>Approved</displayName>
        <gravatarUrl></gravatarUrl>
        <creationDate>2016-06-16T08:58:39.554Z</creationDate>
        <versionState>APPROVED</versionState>
    </deploymentVersionStatus>
    

    XML Schema

    Source: xsd0.xsd

    <xs:complexType name="restDeploymentVersionStatus">
        <xs:sequence>
          <xs:element name="id" type="xs:long"/>
          <xs:element name="userName" type="xs:string" minOccurs="0"/>
          <xs:element name="displayName" type="xs:string" minOccurs="0"/>
          <xs:element name="gravatarUrl" type="xs:string" minOccurs="0"/>
          <xs:element name="creationDate" type="xs:dateTime" minOccurs="0"/>
          <xs:element name="versionState" type="deploymentVersionState" minOccurs="0"/>
        </xs:sequence>
      </xs:complexType><xs:complexType name="restDeploymentVersionStatus">
        <xs:sequence>
          <xs:element name="id" type="xs:long"/>
          <xs:element name="userName" type="xs:string" minOccurs="0"/>
          <xs:element name="displayName" type="xs:string" minOccurs="0"/>
          <xs:element name="gravatarUrl" type="xs:string" minOccurs="0"/>
          <xs:element name="creationDate" type="xs:dateTime" minOccurs="0"/>
          <xs:element name="versionState" type="deploymentVersionState" minOccurs="0"/>
        </xs:sequence>
      </xs:complexType>
  • 404 [expand]

    deployment version not found

/deploy/version/{deploymentVersionId}/status/{newStatus}

resource-wide template parameters
parameter value description

deploymentVersionId

long

deployment version id

newStatus

string

deployment version status. Possible values: UNKNOWN, APPROVED, BROKEN, INCOMPLETE

Methods

POST

Update deployment version status.

available response representations:

  • 200 - application/json (restDeploymentVersionStatus) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <deploymentVersionStatus>
        <id>1</id>
        <userName>admin</userName>
        <displayName>Approved</displayName>
        <gravatarUrl></gravatarUrl>
        <creationDate>2016-06-16T08:58:39.554Z</creationDate>
        <versionState>APPROVED</versionState>
    </deploymentVersionStatus>
    

    XML Schema

    Source: xsd0.xsd

    <xs:complexType name="restDeploymentVersionStatus">
        <xs:sequence>
          <xs:element name="id" type="xs:long"/>
          <xs:element name="userName" type="xs:string" minOccurs="0"/>
          <xs:element name="displayName" type="xs:string" minOccurs="0"/>
          <xs:element name="gravatarUrl" type="xs:string" minOccurs="0"/>
          <xs:element name="creationDate" type="xs:dateTime" minOccurs="0"/>
          <xs:element name="versionState" type="deploymentVersionState" minOccurs="0"/>
        </xs:sequence>
      </xs:complexType><xs:complexType name="restDeploymentVersionStatus">
        <xs:sequence>
          <xs:element name="id" type="xs:long"/>
          <xs:element name="userName" type="xs:string" minOccurs="0"/>
          <xs:element name="displayName" type="xs:string" minOccurs="0"/>
          <xs:element name="gravatarUrl" type="xs:string" minOccurs="0"/>
          <xs:element name="creationDate" type="xs:dateTime" minOccurs="0"/>
          <xs:element name="versionState" type="deploymentVersionState" minOccurs="0"/>
        </xs:sequence>
      </xs:complexType>
  • 400 - application/json (restErrorCollection) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <errors>
        <errors>Unknown deployment version status: MY_STATUS</errors>
        <fieldErrors/>
    </errors>
    

    XML Schema

    Source:

  • 401 [expand]

    For not authorized user

  • 404 [expand]

    Deployment version was not found by deployment version id

/deploy/environment

Methods

/deploy/environment/{environmentId}/results?expand

resource-wide template parameters
parameter value description

environmentId

long

deployment environment id

Methods

GET

Provide list of versions deployed to environment

request query parameters
parameter value description

expand

string

expands deployment versions. Possible values are: results

available response representations:

  • 200 - application/json (restDeploymentResultList) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <restDeploymentResultList expand="results" start-index="0" max-result="2" size="2">
        <results>
            <deploymentVersion>
                <id>15</id>
                <name>version1</name>
                <creationDate>2016-06-16T08:58:39.571Z</creationDate>
                <creatorUserName>Administrator User</creatorUserName>
                <versionStatus>
                    <id>1</id>
                    <userName>admin</userName>
                    <displayName>Approved</displayName>
                    <gravatarUrl></gravatarUrl>
                    <creationDate>2016-06-16T08:58:39.571Z</creationDate>
                    <versionState>APPROVED</versionState>
                </versionStatus>
                <operations>
                    <canView>true</canView>
                    <canEdit>true</canEdit>
                    <canDelete>false</canDelete>
                    <allowedToExecute>false</allowedToExecute>
                    <canExecute>false</canExecute>
                    <cantExecuteReason>Not authorized</cantExecuteReason>
                    <allowedToCreateVersion>false</allowedToCreateVersion>
                    <allowedToSetVersionStatus>false</allowedToSetVersionStatus>
                </operations>
                <creatorDisplayName>Administrator User</creatorDisplayName>
                <creatorGravatarUrl></creatorGravatarUrl>
                <planBranchName>PLAN12</planBranchName>
                <ageZeroPoint>2016-06-16T08:58:39.571Z</ageZeroPoint>
            </deploymentVersion>
            <deploymentVersionName>release-1</deploymentVersionName>
            <id>1</id>
            <deploymentState>SUCCESS</deploymentState>
            <lifeCycleState>FINISHED</lifeCycleState>
            <startedDate>2016-06-16T08:58:39.575Z</startedDate>
            <queuedDate>2016-06-16T08:58:39.575Z</queuedDate>
            <executedDate>2016-06-16T08:58:39.575Z</executedDate>
            <finishedDate>2016-06-16T08:58:39.575Z</finishedDate>
            <reasonSummary>Manual build</reasonSummary>
            <key>
                <key>123-123-1</key>
                <entityKey>
                    <key>123-123</key>
                </entityKey>
                <resultNumber>1</resultNumber>
            </key>
            <operations>
                <canView>true</canView>
                <canEdit>true</canEdit>
                <canDelete>false</canDelete>
                <allowedToExecute>false</allowedToExecute>
                <canExecute>false</canExecute>
                <cantExecuteReason>Not authorized</cantExecuteReason>
                <allowedToCreateVersion>false</allowedToCreateVersion>
                <allowedToSetVersionStatus>false</allowedToSetVersionStatus>
            </operations>
        </results>
        <results>
            <deploymentVersion>
                <id>15</id>
                <name>version1</name>
                <creationDate>2016-06-16T08:58:39.578Z</creationDate>
                <creatorUserName>Administrator User</creatorUserName>
                <versionStatus>
                    <id>1</id>
                    <userName>admin</userName>
                    <displayName>Approved</displayName>
                    <gravatarUrl></gravatarUrl>
                    <creationDate>2016-06-16T08:58:39.578Z</creationDate>
                    <versionState>APPROVED</versionState>
                </versionStatus>
                <operations>
                    <canView>true</canView>
                    <canEdit>true</canEdit>
                    <canDelete>false</canDelete>
                    <allowedToExecute>false</allowedToExecute>
                    <canExecute>false</canExecute>
                    <cantExecuteReason>Not authorized</cantExecuteReason>
                    <allowedToCreateVersion>false</allowedToCreateVersion>
                    <allowedToSetVersionStatus>false</allowedToSetVersionStatus>
                </operations>
                <creatorDisplayName>Administrator User</creatorDisplayName>
                <creatorGravatarUrl></creatorGravatarUrl>
                <planBranchName>PLAN12</planBranchName>
                <ageZeroPoint>2016-06-16T08:58:39.578Z</ageZeroPoint>
            </deploymentVersion>
            <deploymentVersionName>release-2</deploymentVersionName>
            <id>2</id>
            <deploymentState>SUCCESS</deploymentState>
            <lifeCycleState>FINISHED</lifeCycleState>
            <startedDate>2016-06-16T08:58:39.578Z</startedDate>
            <queuedDate>2016-06-16T08:58:39.578Z</queuedDate>
            <executedDate>2016-06-16T08:58:39.578Z</executedDate>
            <finishedDate>2016-06-16T08:58:39.578Z</finishedDate>
            <reasonSummary>Manual build</reasonSummary>
            <key>
                <key>123-123-2</key>
                <entityKey>
                    <key>123-123</key>
                </entityKey>
                <resultNumber>2</resultNumber>
            </key>
            <operations>
                <canView>true</canView>
                <canEdit>true</canEdit>
                <canDelete>false</canDelete>
                <allowedToExecute>false</allowedToExecute>
                <canExecute>false</canExecute>
                <cantExecuteReason>Not authorized</cantExecuteReason>
                <allowedToCreateVersion>false</allowedToCreateVersion>
                <allowedToSetVersionStatus>false</allowedToSetVersionStatus>
            </operations>
        </results>
    </restDeploymentResultList>
    

    XML Schema

    Source:

  • 403 [expand]

    Returns when user don't have VIEW permission for environment

  • 404 [expand]

    Returns when environment not found

/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"/>

/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:

/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:

/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:

/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.

/quickFilter

Methods

GET

Obtain a list of quick filters defined for this Bamboo instance.

available response representations:

  • 200 - application/json [expand]

    List of quick filters. Each entity will contain only basic configuration, excluding e.g. quick filter's rules.

POST

Create a new quick filter with basic configuration, e.g. name or position on list. This method does not allow to configure quick filter's rules.

acceptable request representations:

  • application/json (quickFilter) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <quickFilter>
        <name>Integration Tests</name>
    </quickFilter>
    

    XML Schema

    Source: xsd0.xsd

    <xs:element name="quickFilter" type="restQuickFilter"/><xs:element name="quickFilter" type="restQuickFilter"/>

available response representations:

  • 200 - application/json [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <quickFilter>
        <id>100623</id>
        <name>Integration Tests</name>
        <position>3</position>
        <hasRules>false</hasRules>
    </quickFilter>
    

    Returned when quick filter was created successfully. Response will contain Quick Filter definition with assigned ID.

  • 400 - application/json [expand]

    When any validation errors occur. Response will contain all error messages.

/quickFilter/{id}

resource-wide template parameters
parameter value description

id

long

Methods

GET

Get a single quick filter by ID.

available response representations:

  • 200 - application/json [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <quickFilter>
        <id>100623</id>
        <name>Integration Tests</name>
        <position>3</position>
        <hasRules>false</hasRules>
    </quickFilter>
    

    Single quick filter data. Will contain only basic configuration, excluding e.g. quick filter's rules.

  • 400 - application/json [expand]

    Sent when quick filter was not found with the given ID.

PUT

Update quick filter's basic configuration, e.g. name or position on list. This method does not allow to configure quick filter's rules.

acceptable request representations:

  • application/json (quickFilter) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <quickFilter>
        <id>100623</id>
        <name>Integration Tests</name>
        <position>3</position>
    </quickFilter>
    

    XML Schema

    Source: xsd0.xsd

    <xs:element name="quickFilter" type="restQuickFilter"/><xs:element name="quickFilter" type="restQuickFilter"/>

available response representations:

  • 200 - application/json [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <quickFilter>
        <id>100623</id>
        <name>Integration Tests</name>
        <position>3</position>
        <hasRules>false</hasRules>
    </quickFilter>
    

    Returned when quick filter was updated successfully. Response will contain Quick Filter definition with data after update.

  • 400 - application/json [expand]

    When any validation errors occur or no quick filter was found with given ID. Response will contain all error messages.

DELETE

Delete a quick filter.

available response representations:

  • 400 - application/json [expand]

    Sent when quick filter was not found with the given ID.

  • 204 - application/json [expand]

    Returned when quick filter was deleted successfully.

/quickFilter/active

Methods

GET

Return active quick filters for currently logged in user.

available response representations:

  • 200 - application/json [expand]

    List of active quick filters for logged in user. Each entity will contain only basic configuration, excluding e.g. quick filter's rules.

/quickFilter/{id}/activate

resource-wide template parameters
parameter value description

id

long

Methods

PUT

Activates a quick filter for currently logged in user.

available response representations:

  • 200 - application/json [expand]

    Returned without any content when filter with given ID was successfully activated for current user.

  • 400 - application/json [expand]

    Sent when quick filter was not found with the given ID.

/quickFilter/{id}/deactivate

resource-wide template parameters
parameter value description

id

long

Methods

PUT

Deactivates a quick filter for currently logged in user.

available response representations:

  • 200 - application/json [expand]

    Returned without any content when filter with given ID was successfully deactivated for current user.

  • 400 - application/json [expand]

    Sent when quick filter was not found with the given ID.

/quickFilter/deactivate

Methods

PUT

Deactivates all quick filter for currently logged in user.

available response representations:

  • 200 - application/json [expand]

    Returned without any content when all filters were successfully deactivated for current user.

/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

/

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:

/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:

/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"/>

/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"/>

/deploy/project

Methods

PUT

Create deployment project.

acceptable request representations:

  • application/json (createDeploymentProjectRequest) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <createDeploymentProjectRequest>
        <name>Test deployment</name>
        <planKey>
            <key>PROJ-PLAN</key>
        </planKey>
        <description>Project description</description>
    </createDeploymentProjectRequest>
    

    XML Schema

    Source: xsd0.xsd

    <xs:element name="createDeploymentProjectRequest" type="restCreateDeploymentProjectRequest"/><xs:element name="createDeploymentProjectRequest" type="restCreateDeploymentProjectRequest"/>

available response representations:

  • 200 - application/json (restDeploymentProject) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <deploymentProject>
        <id>12</id>
        <oid>123123123</oid>
        <key>
            <key>213123213</key>
        </key>
        <name>Test deployment</name>
        <planKey>
            <key>PROJ-PLAN</key>
        </planKey>
        <description>Project description</description>
        <environments>
            <id>12</id>
            <key>
                <key>1111</key>
            </key>
            <name>Dev</name>
            <description>Dev environment</description>
            <deploymentProjectId>12</deploymentProjectId>
            <operations>
                <canView>true</canView>
                <canEdit>true</canEdit>
                <canDelete>false</canDelete>
                <allowedToExecute>false</allowedToExecute>
                <canExecute>false</canExecute>
                <cantExecuteReason>Not authorized</cantExecuteReason>
                <allowedToCreateVersion>false</allowedToCreateVersion>
                <allowedToSetVersionStatus>false</allowedToSetVersionStatus>
            </operations>
            <position>0</position>
            <configurationState>TASKED</configurationState>
        </environments>
        <environments>
            <id>17</id>
            <key>
                <key>1111</key>
            </key>
            <name>QA</name>
            <description>QA environment</description>
            <deploymentProjectId>12</deploymentProjectId>
            <operations>
                <canView>true</canView>
                <canEdit>true</canEdit>
                <canDelete>false</canDelete>
                <allowedToExecute>false</allowedToExecute>
                <canExecute>false</canExecute>
                <cantExecuteReason>Not authorized</cantExecuteReason>
                <allowedToCreateVersion>false</allowedToCreateVersion>
                <allowedToSetVersionStatus>false</allowedToSetVersionStatus>
            </operations>
            <position>1</position>
            <configurationState>TASKED</configurationState>
        </environments>
        <operations>
            <canView>true</canView>
            <canEdit>true</canEdit>
            <canDelete>false</canDelete>
            <allowedToExecute>false</allowedToExecute>
            <canExecute>false</canExecute>
            <cantExecuteReason>Not authorized</cantExecuteReason>
            <allowedToCreateVersion>false</allowedToCreateVersion>
            <allowedToSetVersionStatus>false</allowedToSetVersionStatus>
        </operations>
    </deploymentProject>
    

    Created deployment project

    XML Schema

    Source: xsd0.xsd

    <xs:complexType name="restDeploymentProject">
        <xs:sequence>
          <xs:element name="id" type="xs:long"/>
          <xs:element name="oid" type="xs:long" minOccurs="0"/>
          <xs:element ref="key" minOccurs="0"/>
          <xs:element name="name" type="xs:string" minOccurs="0"/>
          <xs:element name="planKey" type="restKey" minOccurs="0"/>
          <xs:element name="description" type="xs:string" minOccurs="0"/>
          <xs:element name="environments" type="restEnvironment" minOccurs="0" maxOccurs="unbounded"/>
          <xs:element ref="operations" minOccurs="0"/>
        </xs:sequence>
      </xs:complexType><xs:complexType name="restDeploymentProject">
        <xs:sequence>
          <xs:element name="id" type="xs:long"/>
          <xs:element name="oid" type="xs:long" minOccurs="0"/>
          <xs:element ref="key" minOccurs="0"/>
          <xs:element name="name" type="xs:string" minOccurs="0"/>
          <xs:element name="planKey" type="restKey" minOccurs="0"/>
          <xs:element name="description" type="xs:string" minOccurs="0"/>
          <xs:element name="environments" type="restEnvironment" minOccurs="0" maxOccurs="unbounded"/>
          <xs:element ref="operations" minOccurs="0"/>
        </xs:sequence>
      </xs:complexType>
  • 400 - application/json (restErrorCollection) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <errors>
        <errors>Can't create deployment project because CreateDeploymentProjectRequest is empty</errors>
        <fieldErrors/>
    </errors>
    

    Validation error

    XML Schema

    Source:

/deploy/project/all

Methods

GET

Find all deployment projects with environments. Returns only deployment projects and environments visible for user.

available response representations:

  • 200 - application/json (deploymentProjectsList) [expand]

    List of deployment projects with environments

    XML Schema

    Source:

/deploy/project/{deploymentProjectId}

resource-wide template parameters
parameter value description

deploymentProjectId

long

deployment project id

Methods

GET

Find deployment project by id.

available response representations:

  • 200 - application/json (restDeploymentProject) [expand]

    return deployment project

    XML Schema

    Source: xsd0.xsd

    <xs:complexType name="restDeploymentProject">
        <xs:sequence>
          <xs:element name="id" type="xs:long"/>
          <xs:element name="oid" type="xs:long" minOccurs="0"/>
          <xs:element ref="key" minOccurs="0"/>
          <xs:element name="name" type="xs:string" minOccurs="0"/>
          <xs:element name="planKey" type="restKey" minOccurs="0"/>
          <xs:element name="description" type="xs:string" minOccurs="0"/>
          <xs:element name="environments" type="restEnvironment" minOccurs="0" maxOccurs="unbounded"/>
          <xs:element ref="operations" minOccurs="0"/>
        </xs:sequence>
      </xs:complexType><xs:complexType name="restDeploymentProject">
        <xs:sequence>
          <xs:element name="id" type="xs:long"/>
          <xs:element name="oid" type="xs:long" minOccurs="0"/>
          <xs:element ref="key" minOccurs="0"/>
          <xs:element name="name" type="xs:string" minOccurs="0"/>
          <xs:element name="planKey" type="restKey" minOccurs="0"/>
          <xs:element name="description" type="xs:string" minOccurs="0"/>
          <xs:element name="environments" type="restEnvironment" minOccurs="0" maxOccurs="unbounded"/>
          <xs:element ref="operations" minOccurs="0"/>
        </xs:sequence>
      </xs:complexType>
  • 404 [expand]

    Can't find deployment project by deploymentProjectId

POST

Update deployment project.

acceptable request representations:

  • application/json (updateDeploymentProjectRequest) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <updateDeploymentProjectRequest>
        <name>Test deployment</name>
        <planKey>
            <key>PROJ-PLAN</key>
        </planKey>
        <description>Project description</description>
    </updateDeploymentProjectRequest>
    

    XML Schema

    Source: xsd0.xsd

    <xs:element name="updateDeploymentProjectRequest" type="restUpdateDeploymentProjectRequest"/><xs:element name="updateDeploymentProjectRequest" type="restUpdateDeploymentProjectRequest"/>

available response representations:

  • 200 - application/json (restDeploymentProject) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <deploymentProject>
        <id>12</id>
        <oid>123123123</oid>
        <key>
            <key>213123213</key>
        </key>
        <name>Test deployment</name>
        <planKey>
            <key>PROJ-PLAN</key>
        </planKey>
        <description>Project description</description>
        <environments>
            <id>12</id>
            <key>
                <key>1111</key>
            </key>
            <name>Dev</name>
            <description>Dev environment</description>
            <deploymentProjectId>12</deploymentProjectId>
            <operations>
                <canView>true</canView>
                <canEdit>true</canEdit>
                <canDelete>false</canDelete>
                <allowedToExecute>false</allowedToExecute>
                <canExecute>false</canExecute>
                <cantExecuteReason>Not authorized</cantExecuteReason>
                <allowedToCreateVersion>false</allowedToCreateVersion>
                <allowedToSetVersionStatus>false</allowedToSetVersionStatus>
            </operations>
            <position>0</position>
            <configurationState>TASKED</configurationState>
        </environments>
        <environments>
            <id>17</id>
            <key>
                <key>1111</key>
            </key>
            <name>QA</name>
            <description>QA environment</description>
            <deploymentProjectId>12</deploymentProjectId>
            <operations>
                <canView>true</canView>
                <canEdit>true</canEdit>
                <canDelete>false</canDelete>
                <allowedToExecute>false</allowedToExecute>
                <canExecute>false</canExecute>
                <cantExecuteReason>Not authorized</cantExecuteReason>
                <allowedToCreateVersion>false</allowedToCreateVersion>
                <allowedToSetVersionStatus>false</allowedToSetVersionStatus>
            </operations>
            <position>1</position>
            <configurationState>TASKED</configurationState>
        </environments>
        <operations>
            <canView>true</canView>
            <canEdit>true</canEdit>
            <canDelete>false</canDelete>
            <allowedToExecute>false</allowedToExecute>
            <canExecute>false</canExecute>
            <cantExecuteReason>Not authorized</cantExecuteReason>
            <allowedToCreateVersion>false</allowedToCreateVersion>
            <allowedToSetVersionStatus>false</allowedToSetVersionStatus>
        </operations>
    </deploymentProject>
    

    return deployment project

    XML Schema

    Source: xsd0.xsd

    <xs:complexType name="restDeploymentProject">
        <xs:sequence>
          <xs:element name="id" type="xs:long"/>
          <xs:element name="oid" type="xs:long" minOccurs="0"/>
          <xs:element ref="key" minOccurs="0"/>
          <xs:element name="name" type="xs:string" minOccurs="0"/>
          <xs:element name="planKey" type="restKey" minOccurs="0"/>
          <xs:element name="description" type="xs:string" minOccurs="0"/>
          <xs:element name="environments" type="restEnvironment" minOccurs="0" maxOccurs="unbounded"/>
          <xs:element ref="operations" minOccurs="0"/>
        </xs:sequence>
      </xs:complexType><xs:complexType name="restDeploymentProject">
        <xs:sequence>
          <xs:element name="id" type="xs:long"/>
          <xs:element name="oid" type="xs:long" minOccurs="0"/>
          <xs:element ref="key" minOccurs="0"/>
          <xs:element name="name" type="xs:string" minOccurs="0"/>
          <xs:element name="planKey" type="restKey" minOccurs="0"/>
          <xs:element name="description" type="xs:string" minOccurs="0"/>
          <xs:element name="environments" type="restEnvironment" minOccurs="0" maxOccurs="unbounded"/>
          <xs:element ref="operations" minOccurs="0"/>
        </xs:sequence>
      </xs:complexType>
  • 400 - application/json [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <errors>
        <errors>No deployment project was found for the given ID 123</errors>
        <fieldErrors/>
    </errors>
    

    Validation error

  • 404 [expand]

    Can't find deployment project by deploymentProjectId

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

resource-wide template parameters
parameter value description

deploymentProjectId

long

deployment project id

Methods

GET

Get list of deployment versions by deployment project id

request query parameters
parameter value description

branchKey

string

plan branch key. Can be empty if default branch is required

available response representations:

  • 200 - application/json (restDeploymentVersionList) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <deploymentVersions start-index="0" max-result="2" size="2">
        <versions>
            <id>15</id>
            <name>version1</name>
            <creationDate>2016-06-16T08:58:39.447Z</creationDate>
            <creatorUserName>Administrator User</creatorUserName>
            <versionStatus>
                <id>1</id>
                <userName>admin</userName>
                <displayName>Approved</displayName>
                <gravatarUrl></gravatarUrl>
                <creationDate>2016-06-16T08:58:39.447Z</creationDate>
                <versionState>APPROVED</versionState>
            </versionStatus>
            <operations>
                <canView>true</canView>
                <canEdit>true</canEdit>
                <canDelete>false</canDelete>
                <allowedToExecute>false</allowedToExecute>
                <canExecute>false</canExecute>
                <cantExecuteReason>Not authorized</cantExecuteReason>
                <allowedToCreateVersion>false</allowedToCreateVersion>
                <allowedToSetVersionStatus>false</allowedToSetVersionStatus>
            </operations>
            <creatorDisplayName>Administrator User</creatorDisplayName>
            <creatorGravatarUrl></creatorGravatarUrl>
            <planBranchName>PLAN12</planBranchName>
            <ageZeroPoint>2016-06-16T08:58:39.447Z</ageZeroPoint>
        </versions>
        <versions>
            <id>15</id>
            <name>version1</name>
            <creationDate>2016-06-16T08:58:39.447Z</creationDate>
            <creatorUserName>Administrator User</creatorUserName>
            <versionStatus>
                <id>1</id>
                <userName>admin</userName>
                <displayName>Approved</displayName>
                <gravatarUrl></gravatarUrl>
                <creationDate>2016-06-16T08:58:39.447Z</creationDate>
                <versionState>APPROVED</versionState>
            </versionStatus>
            <operations>
                <canView>true</canView>
                <canEdit>true</canEdit>
                <canDelete>false</canDelete>
                <allowedToExecute>false</allowedToExecute>
                <canExecute>false</canExecute>
                <cantExecuteReason>Not authorized</cantExecuteReason>
                <allowedToCreateVersion>false</allowedToCreateVersion>
                <allowedToSetVersionStatus>false</allowedToSetVersionStatus>
            </operations>
            <creatorDisplayName>Administrator User</creatorDisplayName>
            <creatorGravatarUrl></creatorGravatarUrl>
            <planBranchName>PLAN12</planBranchName>
            <ageZeroPoint>2016-06-16T08:58:39.447Z</ageZeroPoint>
        </versions>
    </deploymentVersions>
    

    deployment project versions

    XML Schema

    Source:

  • 400 [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <errors>
        <errors>Please provide a valid planBranchKey</errors>
        <fieldErrors/>
    </errors>
    

    Validation error during deployment project update

  • 404 [expand]

    Can't find deployment project by deploymentProjectId

/deploy/project/{deploymentProjectId}/version

resource-wide template parameters
parameter value description

deploymentProjectId

long

id of deployment project

Methods

POST

Create deployment version for given deployment project.

acceptable request representations:

  • application/json (restCreateVersionRequest) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <restCreateVersionRequest>
        <planResultKey>PRJ-PLN-2</planResultKey>
        <name>version1</name>
        <nextVersionName>version2</nextVersionName>
    </restCreateVersionRequest>
    

    XML Schema

    Source: xsd0.xsd

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

available response representations:

  • 200 - application/json (restDeploymentVersion) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <version>
        <id>15</id>
        <name>version1</name>
        <creationDate>2016-06-16T08:58:39.422Z</creationDate>
        <creatorUserName>Administrator User</creatorUserName>
        <versionStatus>
            <id>1</id>
            <userName>admin</userName>
            <displayName>Approved</displayName>
            <gravatarUrl></gravatarUrl>
            <creationDate>2016-06-16T08:58:39.428Z</creationDate>
            <versionState>APPROVED</versionState>
        </versionStatus>
        <operations>
            <canView>true</canView>
            <canEdit>true</canEdit>
            <canDelete>false</canDelete>
            <allowedToExecute>false</allowedToExecute>
            <canExecute>false</canExecute>
            <cantExecuteReason>Not authorized</cantExecuteReason>
            <allowedToCreateVersion>false</allowedToCreateVersion>
            <allowedToSetVersionStatus>false</allowedToSetVersionStatus>
        </operations>
        <creatorDisplayName>Administrator User</creatorDisplayName>
        <creatorGravatarUrl></creatorGravatarUrl>
        <planBranchName>PLAN12</planBranchName>
        <ageZeroPoint>2016-06-16T08:58:39.429Z</ageZeroPoint>
    </version>
    

    XML Schema

    Source: xsd0.xsd

    <xs:complexType name="restDeploymentVersion">
        <xs:sequence>
          <xs:element name="id" type="xs:long"/>
          <xs:element name="name" type="xs:string" minOccurs="0"/>
          <xs:element name="creationDate" type="xs:dateTime" minOccurs="0"/>
          <xs:element name="creatorUserName" type="xs:string" minOccurs="0"/>
          <xs:element name="items" type="restDeploymentVersionItem" minOccurs="0" maxOccurs="unbounded"/>
          <xs:element name="versionStatus" type="restDeploymentVersionStatus" minOccurs="0"/>
          <xs:element ref="operations" minOccurs="0"/>
          <xs:element name="creatorDisplayName" type="xs:string" minOccurs="0"/>
          <xs:element name="creatorGravatarUrl" type="xs:string" minOccurs="0"/>
          <xs:element name="planBranchName" type="xs:string" minOccurs="0"/>
          <xs:element name="ageZeroPoint" type="xs:dateTime" minOccurs="0"/>
        </xs:sequence>
      </xs:complexType><xs:complexType name="restDeploymentVersion">
        <xs:sequence>
          <xs:element name="id" type="xs:long"/>
          <xs:element name="name" type="xs:string" minOccurs="0"/>
          <xs:element name="creationDate" type="xs:dateTime" minOccurs="0"/>
          <xs:element name="creatorUserName" type="xs:string" minOccurs="0"/>
          <xs:element name="items" type="restDeploymentVersionItem" minOccurs="0" maxOccurs="unbounded"/>
          <xs:element name="versionStatus" type="restDeploymentVersionStatus" minOccurs="0"/>
          <xs:element ref="operations" minOccurs="0"/>
          <xs:element name="creatorDisplayName" type="xs:string" minOccurs="0"/>
          <xs:element name="creatorGravatarUrl" type="xs:string" minOccurs="0"/>
          <xs:element name="planBranchName" type="xs:string" minOccurs="0"/>
          <xs:element name="ageZeroPoint" type="xs:dateTime" minOccurs="0"/>
        </xs:sequence>
      </xs:complexType>
  • 400 - application/json (restErrorCollection) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <errors>
        <fieldErrors>
            <entry>
                <key>versionName</key>
                <value/>
            </entry>
        </fieldErrors>
    </errors>
    

    Returns when validation error occurred

    XML Schema

    Source:

  • 401 [expand]

    Returns for anonymous access

  • 403 [expand]

    Returns when user don't have permissions to create version in deployment project

/deploy/project/forPlan?planKey

Methods

GET

Get list of deployment projects for build plan.

request query parameters
parameter value description

planKey

string

plan key. Required

available response representations:

  • 200 - application/json (restLinkedDeploymentProjectList) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <restLinkedDeploymentProject>
        <id>12</id>
        <name>Deployment project 1</name>
        <description>Deployment project 1 description</description>
    </restLinkedDeploymentProject>
    

    list of linked deployment projects

    XML Schema

    Source:

  • 400 - application/json (restErrorCollection) [expand]

    Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <errors>
        <errors>Please provide a valid plan key</errors>
        <fieldErrors/>
    </errors>
    

    when plan key is empty or plan don't found

    XML Schema

    Source:

/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:

DELETE

request query parameters
parameter value description

executorType

string

executorId

long

assignmentType

string

entityId

long

available response representations:

/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/preview

Methods

/deploy/preview/possibleResults?planKey&deploymentProjectId

Methods

GET

request query parameters
parameter value description

planKey

string

deploymentProjectId

long

available response representations:

/deploy/preview/versionName?deploymentProjectId&resultKey

Methods

GET

request query parameters
parameter value description

deploymentProjectId

long

resultKey

string

available response representations:

/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"/>

/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"/>

/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"/>

/deploy/projectVersioning

Methods

/deploy/projectVersioning/{deploymentProjectId}/variables

resource-wide template parameters
parameter value description

deploymentProjectId

long

deployment project id

Methods

GET

Get variables associated with deployment project.

available response representations:

  • 200 - application/json (versionVariables) [expand]
    XML Schema

    Source:

  • 400 [expand]

    Validation error

  • 404 [expand]

    Deployment project not found

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

resource-wide template parameters
parameter value description

deploymentProjectId

long

deployment project id

Methods

GET

Get deployment version name preview.

request query parameters
parameter value description

nextVersionName

string

name version. Mandatory

incrementNumbers

boolean

if version number should be incremented

incrementableVariables

string

variables used for version name. Divided by coma

available response representations:

  • 200 - application/json (restNamingPreview) [expand]
    XML Schema

    Source:

  • 400 - application/json [expand]

    Validation error

  • 404 [expand]

    Deployment project not found

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

resource-wide template parameters
parameter value description

deploymentProjectId

long

deployment project id

Methods

GET

Get next deployment version name

request query parameters
parameter value description

resultKey

string

build result key

available response representations:

  • 200 - application/json (restNamingPreview) [expand]
    XML Schema

    Source:

  • 400 - application/json [expand]

    Validation error

  • 404 [expand]

    Deployment project not found

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

resource-wide template parameters
parameter value description

deploymentProjectId

long

deployment project id

Methods

GET

Extract variables value from version name.

request query parameters
parameter value description

nextVersionName

string

version name

available response representations:

  • 200 - application/json [expand]
  • 400 - application/json [expand]

    Validation error

  • 404 [expand]

    Deployment project not found

/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"/>

/deploy/issue-status

Methods

/deploy/issue-status/{issueKey}

resource-wide template parameters
parameter value description

issueKey

string

JIRA issue key. Mandatory

Methods

GET

Get deployment project environments and versions associated with JIRA issue

available response representations:

  • 200 - application/json (restDeploymentProjectStatusForJiraIssue) [expand]
    XML Schema

    Source:

  • 404 [expand]

    deployment project not found

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

resource-wide template parameters
parameter value description

issueKey

string

JIRA issue key. Mandatory

deploymentProjectId

long

deployment project id

Methods

GET

Get deployment project environments and versions associated with JIRA issue

available response representations:

  • 200 - application/json (restDeploymentProjectStatusForJiraIssue) [expand]
    XML Schema

    Source:

  • 404 [expand]

    deployment project not found

/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-06-16T08:58:39.636Z</buildStartedTime>
                <prettyBuildStartedTime>2016-06-16T08:58:39</prettyBuildStartedTime>
                <buildCompletedTime>2016-06-16T08:58:39.636Z</buildCompletedTime>
                <buildCompletedDate>2016-06-16T08:58:39.636Z</buildCompletedDate>
                <prettyBuildCompletedTime>2016-06-16T08:58:39</prettyBuildCompletedTime>
                <buildDurationInSeconds>1</buildDurationInSeconds>
                <buildDuration>1000</buildDuration>
                <buildDurationDescription>1 second</buildDurationDescription>
                <buildRelativeTime>1 hour ago</buildRelativeTime>
                <queueStartedTime>2016-06-16T08:58:39.637Z</queueStartedTime>
                <prettyQueueStartedTime>2016-06-16T08:58:39</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-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</modificationDate>
                    </comment>
                    <comment author="bambooUser">
                        <content>Sample comment for build</content>
                        <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</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-06-16T08:58:39.656Z</buildStartedTime>
                <prettyBuildStartedTime>2016-06-16T08:58:39</prettyBuildStartedTime>
                <buildCompletedTime>2016-06-16T08:58:39.656Z</buildCompletedTime>
                <buildCompletedDate>2016-06-16T08:58:39.656Z</buildCompletedDate>
                <prettyBuildCompletedTime>2016-06-16T08:58:39</prettyBuildCompletedTime>
                <buildDurationInSeconds>1</buildDurationInSeconds>
                <buildDuration>1000</buildDuration>
                <buildDurationDescription>1 second</buildDurationDescription>
                <buildRelativeTime>1 hour ago</buildRelativeTime>
                <queueStartedTime>2016-06-16T08:58:39.656Z</queueStartedTime>
                <prettyQueueStartedTime>2016-06-16T08:58:39</prettyQueueStartedTime>
                <restartCount>0</restartCount>
                <comments start-index="0" max-result="2" size="0">
                    <comment author="bambooUser">
                        <content>Sample comment for build</content>
                        <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</modificationDate>
                    </comment>
                    <comment author="bambooUser">
                        <content>Sample comment for build</content>
                        <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</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-06-16T08:58:39.636Z</buildStartedTime>
        <prettyBuildStartedTime>2016-06-16T08:58:39</prettyBuildStartedTime>
        <buildCompletedTime>2016-06-16T08:58:39.636Z</buildCompletedTime>
        <buildCompletedDate>2016-06-16T08:58:39.636Z</buildCompletedDate>
        <prettyBuildCompletedTime>2016-06-16T08:58:39</prettyBuildCompletedTime>
        <buildDurationInSeconds>1</buildDurationInSeconds>
        <buildDuration>1000</buildDuration>
        <buildDurationDescription>1 second</buildDurationDescription>
        <buildRelativeTime>1 hour ago</buildRelativeTime>
        <queueStartedTime>2016-06-16T08:58:39.637Z</queueStartedTime>
        <prettyQueueStartedTime>2016-06-16T08:58:39</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-06-16T08:58:39.638Z</creationDate>
                <modificationDate>2016-06-16T08:58:39.638Z</modificationDate>
            </comment>
            <comment author="bambooUser">
                <content>Sample comment for build</content>
                <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                <modificationDate>2016-06-16T08:58:39.638Z</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-06-16T08:58:39.649Z</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-06-16T08:58:39.649Z</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-06-16T08:58:39.655Z</buildStartedTime>
                <prettyBuildStartedTime>2016-06-16T08:58:39</prettyBuildStartedTime>
                <buildCompletedTime>2016-06-16T08:58:39.655Z</buildCompletedTime>
                <buildCompletedDate>2016-06-16T08:58:39.655Z</buildCompletedDate>
                <prettyBuildCompletedTime>2016-06-16T08:58:39</prettyBuildCompletedTime>
                <buildDurationInSeconds>1</buildDurationInSeconds>
                <buildDuration>1000</buildDuration>
                <buildDurationDescription>1 second</buildDurationDescription>
                <buildRelativeTime>1 hour ago</buildRelativeTime>
                <queueStartedTime>2016-06-16T08:58:39.655Z</queueStartedTime>
                <prettyQueueStartedTime>2016-06-16T08:58:39</prettyQueueStartedTime>
                <restartCount>0</restartCount>
                <comments start-index="0" max-result="2" size="0">
                    <comment author="bambooUser">
                        <content>Sample comment for build</content>
                        <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</modificationDate>
                    </comment>
                    <comment author="bambooUser">
                        <content>Sample comment for build</content>
                        <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</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-06-16T08:58:39.655Z</buildStartedTime>
                <prettyBuildStartedTime>2016-06-16T08:58:39</prettyBuildStartedTime>
                <buildCompletedTime>2016-06-16T08:58:39.655Z</buildCompletedTime>
                <buildCompletedDate>2016-06-16T08:58:39.655Z</buildCompletedDate>
                <prettyBuildCompletedTime>2016-06-16T08:58:39</prettyBuildCompletedTime>
                <buildDurationInSeconds>1</buildDurationInSeconds>
                <buildDuration>1000</buildDuration>
                <buildDurationDescription>1 second</buildDurationDescription>
                <buildRelativeTime>1 hour ago</buildRelativeTime>
                <queueStartedTime>2016-06-16T08:58:39.655Z</queueStartedTime>
                <prettyQueueStartedTime>2016-06-16T08:58:39</prettyQueueStartedTime>
                <restartCount>0</restartCount>
                <comments start-index="0" max-result="2" size="0">
                    <comment author="bambooUser">
                        <content>Sample comment for build</content>
                        <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</modificationDate>
                    </comment>
                    <comment author="bambooUser">
                        <content>Sample comment for build</content>
                        <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</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-06-16T08:58:39.636Z</buildStartedTime>
                <prettyBuildStartedTime>2016-06-16T08:58:39</prettyBuildStartedTime>
                <buildCompletedTime>2016-06-16T08:58:39.636Z</buildCompletedTime>
                <buildCompletedDate>2016-06-16T08:58:39.636Z</buildCompletedDate>
                <prettyBuildCompletedTime>2016-06-16T08:58:39</prettyBuildCompletedTime>
                <buildDurationInSeconds>1</buildDurationInSeconds>
                <buildDuration>1000</buildDuration>
                <buildDurationDescription>1 second</buildDurationDescription>
                <buildRelativeTime>1 hour ago</buildRelativeTime>
                <queueStartedTime>2016-06-16T08:58:39.637Z</queueStartedTime>
                <prettyQueueStartedTime>2016-06-16T08:58:39</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-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</modificationDate>
                    </comment>
                    <comment author="bambooUser">
                        <content>Sample comment for build</content>
                        <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</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-06-16T08:58:39.655Z</buildStartedTime>
                <prettyBuildStartedTime>2016-06-16T08:58:39</prettyBuildStartedTime>
                <buildCompletedTime>2016-06-16T08:58:39.655Z</buildCompletedTime>
                <buildCompletedDate>2016-06-16T08:58:39.655Z</buildCompletedDate>
                <prettyBuildCompletedTime>2016-06-16T08:58:39</prettyBuildCompletedTime>
                <buildDurationInSeconds>1</buildDurationInSeconds>
                <buildDuration>1000</buildDuration>
                <buildDurationDescription>1 second</buildDurationDescription>
                <buildRelativeTime>1 hour ago</buildRelativeTime>
                <queueStartedTime>2016-06-16T08:58:39.655Z</queueStartedTime>
                <prettyQueueStartedTime>2016-06-16T08:58:39</prettyQueueStartedTime>
                <restartCount>0</restartCount>
                <comments start-index="0" max-result="2" size="0">
                    <comment author="bambooUser">
                        <content>Sample comment for build</content>
                        <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</modificationDate>
                    </comment>
                    <comment author="bambooUser">
                        <content>Sample comment for build</content>
                        <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</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-06-16T08:58:39.636Z</buildStartedTime>
                <prettyBuildStartedTime>2016-06-16T08:58:39</prettyBuildStartedTime>
                <buildCompletedTime>2016-06-16T08:58:39.636Z</buildCompletedTime>
                <buildCompletedDate>2016-06-16T08:58:39.636Z</buildCompletedDate>
                <prettyBuildCompletedTime>2016-06-16T08:58:39</prettyBuildCompletedTime>
                <buildDurationInSeconds>1</buildDurationInSeconds>
                <buildDuration>1000</buildDuration>
                <buildDurationDescription>1 second</buildDurationDescription>
                <buildRelativeTime>1 hour ago</buildRelativeTime>
                <queueStartedTime>2016-06-16T08:58:39.637Z</queueStartedTime>
                <prettyQueueStartedTime>2016-06-16T08:58:39</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-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</modificationDate>
                    </comment>
                    <comment author="bambooUser">
                        <content>Sample comment for build</content>
                        <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</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-06-16T08:58:39.655Z</buildStartedTime>
                <prettyBuildStartedTime>2016-06-16T08:58:39</prettyBuildStartedTime>
                <buildCompletedTime>2016-06-16T08:58:39.655Z</buildCompletedTime>
                <buildCompletedDate>2016-06-16T08:58:39.655Z</buildCompletedDate>
                <prettyBuildCompletedTime>2016-06-16T08:58:39</prettyBuildCompletedTime>
                <buildDurationInSeconds>1</buildDurationInSeconds>
                <buildDuration>1000</buildDuration>
                <buildDurationDescription>1 second</buildDurationDescription>
                <buildRelativeTime>1 hour ago</buildRelativeTime>
                <queueStartedTime>2016-06-16T08:58:39.655Z</queueStartedTime>
                <prettyQueueStartedTime>2016-06-16T08:58:39</prettyQueueStartedTime>
                <restartCount>0</restartCount>
                <comments start-index="0" max-result="2" size="0">
                    <comment author="bambooUser">
                        <content>Sample comment for build</content>
                        <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</modificationDate>
                    </comment>
                    <comment author="bambooUser">
                        <content>Sample comment for build</content>
                        <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</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-06-16T08:58:39.636Z</buildStartedTime>
                <prettyBuildStartedTime>2016-06-16T08:58:39</prettyBuildStartedTime>
                <buildCompletedTime>2016-06-16T08:58:39.636Z</buildCompletedTime>
                <buildCompletedDate>2016-06-16T08:58:39.636Z</buildCompletedDate>
                <prettyBuildCompletedTime>2016-06-16T08:58:39</prettyBuildCompletedTime>
                <buildDurationInSeconds>1</buildDurationInSeconds>
                <buildDuration>1000</buildDuration>
                <buildDurationDescription>1 second</buildDurationDescription>
                <buildRelativeTime>1 hour ago</buildRelativeTime>
                <queueStartedTime>2016-06-16T08:58:39.637Z</queueStartedTime>
                <prettyQueueStartedTime>2016-06-16T08:58:39</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-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</modificationDate>
                    </comment>
                    <comment author="bambooUser">
                        <content>Sample comment for build</content>
                        <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</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-06-16T08:58:39.655Z</buildStartedTime>
                <prettyBuildStartedTime>2016-06-16T08:58:39</prettyBuildStartedTime>
                <buildCompletedTime>2016-06-16T08:58:39.655Z</buildCompletedTime>
                <buildCompletedDate>2016-06-16T08:58:39.655Z</buildCompletedDate>
                <prettyBuildCompletedTime>2016-06-16T08:58:39</prettyBuildCompletedTime>
                <buildDurationInSeconds>1</buildDurationInSeconds>
                <buildDuration>1000</buildDuration>
                <buildDurationDescription>1 second</buildDurationDescription>
                <buildRelativeTime>1 hour ago</buildRelativeTime>
                <queueStartedTime>2016-06-16T08:58:39.655Z</queueStartedTime>
                <prettyQueueStartedTime>2016-06-16T08:58:39</prettyQueueStartedTime>
                <restartCount>0</restartCount>
                <comments start-index="0" max-result="2" size="0">
                    <comment author="bambooUser">
                        <content>Sample comment for build</content>
                        <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</modificationDate>
                    </comment>
                    <comment author="bambooUser">
                        <content>Sample comment for build</content>
                        <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</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-06-16T08:58:39.636Z</buildStartedTime>
                <prettyBuildStartedTime>2016-06-16T08:58:39</prettyBuildStartedTime>
                <buildCompletedTime>2016-06-16T08:58:39.636Z</buildCompletedTime>
                <buildCompletedDate>2016-06-16T08:58:39.636Z</buildCompletedDate>
                <prettyBuildCompletedTime>2016-06-16T08:58:39</prettyBuildCompletedTime>
                <buildDurationInSeconds>1</buildDurationInSeconds>
                <buildDuration>1000</buildDuration>
                <buildDurationDescription>1 second</buildDurationDescription>
                <buildRelativeTime>1 hour ago</buildRelativeTime>
                <queueStartedTime>2016-06-16T08:58:39.637Z</queueStartedTime>
                <prettyQueueStartedTime>2016-06-16T08:58:39</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-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</modificationDate>
                    </comment>
                    <comment author="bambooUser">
                        <content>Sample comment for build</content>
                        <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                        <modificationDate>2016-06-16T08:58:39.638Z</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-06-16T08:58:39.636Z</buildStartedTime>
        <prettyBuildStartedTime>2016-06-16T08:58:39</prettyBuildStartedTime>
        <buildCompletedTime>2016-06-16T08:58:39.636Z</buildCompletedTime>
        <buildCompletedDate>2016-06-16T08:58:39.636Z</buildCompletedDate>
        <prettyBuildCompletedTime>2016-06-16T08:58:39</prettyBuildCompletedTime>
        <buildDurationInSeconds>1</buildDurationInSeconds>
        <buildDuration>1000</buildDuration>
        <buildDurationDescription>1 second</buildDurationDescription>
        <buildRelativeTime>1 hour ago</buildRelativeTime>
        <queueStartedTime>2016-06-16T08:58:39.637Z</queueStartedTime>
        <prettyQueueStartedTime>2016-06-16T08:58:39</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-06-16T08:58:39.638Z</creationDate>
                <modificationDate>2016-06-16T08:58:39.638Z</modificationDate>
            </comment>
            <comment author="bambooUser">
                <content>Sample comment for build</content>
                <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                <modificationDate>2016-06-16T08:58:39.638Z</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-06-16T08:58:39.649Z</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-06-16T08:58:39.649Z</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-06-16T08:58:39.638Z</creationDate>
                <modificationDate>2016-06-16T08:58:39.638Z</modificationDate>
            </comment>
            <comment author="bambooUser">
                <content>Sample comment for build</content>
                <creationDate>2016-06-16T08:58:39.638Z</creationDate>
                <modificationDate>2016-06-16T08:58:39.638Z</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-06-16T08:58:40</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

/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"/>

/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:

DELETE

available response representations:

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

resource-wide template parameters
parameter value description

projectKey

string

buildKey

string

Methods

POST

available response representations:

DELETE

available response representations:

/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:

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

resource-wide template parameters
parameter value description

projectKey

string

buildKey

string

testId

long

Methods

POST

available response representations: