Showing results for 
Search instead for 
Did you mean: 
Sign up Log in
It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

assign dedicated external bamboo agent to project



I am trying to do a dedicated assigment between a external agent and a plan/job or whatever, using the bamboo rest api.

I found in the Documentation this.





should be AGENT or IMAGE



executor id. Id of agent or elastic image.






entity id. Identifier of project, plan, job, deployment project or environment.



I am wondering what entityId really is and where i can find it from eacht Plan, job ..

Its waiting for a long so, jobkey or plankey will not work.


Also on the get 


What the heck should entityType be?

The rest api seems to be not very good documented :-(


Any help would be much appriciated.

1 answer

0 votes

Hi @phlo_z,



The entityID is the ID used to identify the project/plan/job in the Bamboo database. That is a design issue that blocks this API to be used only through a sequence of rest APIs.

There are some improvement requests related to this issue already reported:

There are also internal discussions to change the agent assignment REST endpoint to make it use only project/plan/job keys which would make things a lot easier.

The API will work completely through APIs if you need to assign deployments/environments.

To get the de IDs you need to call:

  • /rest/api/latest/deploy/project/all



Regarding the executorID, you can get it from:

  • /rest/api/latest/agent
    The field is id (agent id).


Steps to do the agent assignment

  1. Get the executorID which is the agent id using the following call:
    curl -X GET -u <USER>:<PASSWORD> "<BAMBOO_URL>/rest/api/latest/agent"
  2. Get the entityID from either the DB (project/plan/job) as shared above or use the deployment call below:
    curl -X GET -u <USER>:<PASSWORD> "<BAMBOO_URL>/rest/api/latest/deploy/project/all"
  3. Assign the agent with the following call:
    curl -X POST -u <USER>:<PASSWORD> "<BAMBOO_URL>/rest/api/latest/agent/assignment?executorType=AGENT&executorId=<EXECUTOR_ID>&assignmentType=<ASSIGNMENT_TYPE>&entityId=<ENTITY_ID>" 

I hope that helps.

It is disappointing at the least that the API does not provide the build project id nor is it visible in the UI. Are you aware of any plugins that expose this data?

Suggest an answer

Log in or Sign up to answer
Community showcase
Published in Bamboo

Bamboo Data Center 8.1 is now available

G’day Bamboo customers, Bamboo DC 8.1 is now available with it the following features and programs: SAML 2.0, OpenID Connect, and Crowd SSO In order to help admins with a simplified user manage...

194 views 0 4
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you