Showing results for 
Search instead for 
Did you mean: 
Sign up Log in

REST API: check if any plan in bamboo project is currently building

helmerm June 19, 2013
Hi, I am trying to write an app which accesses the REST API and checks whether any plan in a specific bamboo project is currently building. The result overview (https://bamboo/build/rest/api/latest/result/Project) only shows me all finished builds and not builds which are currently in progress. Is there an easy way to get this information? Thanks, Martin

18 answers

2 votes
John Bowker February 18, 2014

Use the rest/api/latest/plan/{BuildKey} REST call and look for isBuilding.

Odin Odin February 18, 2014

John: rest/api/latest/plan does not cover branches builds though.

Nadsa August 27, 2019

This is very helpful. Thanks.

2 votes
Dan Rumney November 26, 2013

I wanted to give this a bump.

The QUEUE service only lists what is waiting to start building.

The RESULT service only lists what has been completed.

There seems to be a gap here. Is there any way to find out what is *currently* building?

1 vote
stephan_wentz February 17, 2014

Seriously? There is no endpoint for this?

0 votes
schow-lmi3d April 8, 2019


I check for the key ''lifeCycleState' in the json response.

If you see 'InProgress, its currently being built. i.e {'lifeCycleState':'InProgress'}

0 votes
Dean Nam November 26, 2018
0 votes
Jesse Quattlebaum November 8, 2017

I think this might be what you are looking for:

wget -q -O agent.txt --http-user=%LOGIN% --http-password=%PASSWORD% "http://localhost:8085/rest/api/latest/agent?os_authType=basic"

The output is json and shows what the agents are currently doing.  In particular there is an element 'busy' that will be true or false for each agent:

0 votes
Luca Pino January 19, 2017

There is a query parameter to get all the results, including the ones that are building: 


For example you could use it in:

Kai Paro August 1, 2017

sorry for the old bump on this -- looks like this only returns data on top level plans, is there anyway to check status on builds from lower branches?

Alexey Chystoprudov
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
August 2, 2017

Use a plan branch key as path parameter


Kai Paro August 16, 2017

This looks like the same line i responded to from Luca... am i missing something? 

0 votes
vikas027 January 19, 2017

One can use this, the result is either false or true

curl -ks --user <user>:<password> http://<bamboo_server>/rest/api/latest/plan/<project_key>-<plan_key>.json | jq .isBuilding
0 votes
Poul_Nielsen June 12, 2016

ugly one:

curl -u uid:pw http://bambooserver/admin/agent/configureAgents!default.action | grep Building | wc -l

not nice but it will give you the number of agents currently building,

or you could regexp it

good luck


0 votes
Luca Pino March 23, 2016

I would suggest to vote for this to happen:

0 votes
hinok January 30, 2016


I'd like to inform you that in next few weeks I am going to release my package on npm which exposes API with all builds information like what is currently building, what is in the queue, how looks recent builds etc.

In the first release frontend side (I will make something like wallboard) and backend will be in the one package, but in future I think that I will split package into two standalone repos: backend - api, frontend. Cross your fingers wink

0 votes
Andrew Goodman October 28, 2015

Is there still no API for this?

0 votes
John Bowker February 18, 2014

If you just want to see active builds visually you can use the Build Activity Screen in Bamboo 5. Its not pretty like the wallboard but it will show you everything running as well as agent usage:


Build -> Build Activity

0 votes
stephan_wentz February 18, 2014

I'm still conviced that there should be an endpoint for all running builds.

We are using Atlasboard to show stuff on a screen in our office, and we want (beneath others) to show all currently running builds.

Don't want to iterate over all Projects or Plans to get this information...

0 votes
John Bowker February 18, 2014

For branch builds just pass the branch build key which is normally just the parent key with the branch id appended.

So if your parent key is BUILD-FULL your branch key will be BUILD-FULL0.

To script this better just expand the branches in the plan REST CALL to get the key name.

0 votes
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
February 17, 2014

currentActivity.action will tell you what is currently building but I don't know of any way to get it via rest or filter it for a specific plan. You might look in the api doc for currentActivity and see if you can find anything.

0 votes
Odin Odin January 12, 2014

Bump, is there really no REST API for knowing what is currently building?

0 votes
Adam Myatt June 19, 2013

You can try the QUEUE service, though that may only be plans waiting to be built.

Suggest an answer

Log in or Sign up to answer
AUG Leaders

Atlassian Community Events