Maintenance Operations

APIs to start and finish remote automation task that takes agents offline safely and ensures build farm capacity set in Admin Configuration

Security Note

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

Request Start / Creation of Maintenance Task CHANGE

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.

Click here to expand response...

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

Report Task Completion / Success CHANGE

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.

Click 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

Poll Target Version READ

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

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.

Click here to expand response...

PVERSION=1.2.1