Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note
titleSecurity Note

All operations on this page require valid Access Tokens see Access Token Operations for more information on creating tokens.

Table of Contents
maxLevel5
minLevel5

Panel

Request Start / Creation of Maintenance Task 
Status
subtletrue
colourYellow
titlechange

Attempts to create a maintenance task which results in the agent being disabled, and a task in progress.

POST /rest/agents/1.0/{AGENT_ID}/maintenance?uuid={tokenId}   


See Chaperone Permissions and Responses for all possible responses.

Expand
titleClick here to expand response...

PCODE=YES_CHILD
PMESSAGE="you may upgrade once idle"
PVERSION=1.2
ENABLED=false
BUSY=false
TASK=1 

Panel

Report Task Completion / Success  
Status
subtletrue
colourYellow
titlechange

Notifies that the agent previously marked for maintenance is ready to again receive jobs. Can be used to register replacement agents as well, only former task ID is needed.

PUT /rest/agents/1.0/{AGENT_ID}/maintenance/{TASK_ID}/finish?uuid={tokenId}   


See Chaperone Permissions and Responses for all possible responses.

Expand
titleClick here to expand response...

PCODE=NO_CHILD
PMESSAGE="Thanks for reporting. Letting the others catch up"
PVERSION=1.2
ENABLED=true
BUSY=false
TASK=0

...

Panel

Poll Target Version  
Status
subtletrue
colourGreen
titleREad

Stateless operation to poll the latest version that Bamboo Master is configured with. (Use in conjunction with Version Update Task for fully automated updates of bamboo agents from bamboo!)

GET /rest/agents/1.0/polling/version


Warning

Do not upgrade agents based on this!!!

If the agent determines this version different from current, it can use APIs above to actually request maintenance. Performing maintenance on an agent without knowing there is adequate capacity in the build farm puts your platform at risk.

Expand
titleClick here to expand response...


PVERSION=1.2.1

...