Versions Compared

Old Version 2

changes.mady.by.user Eddie Webbinaro

Saved on

compared with

New Version 3

changes.mady.by.user Eddie Webbinaro

Saved on

Key

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

Excerpt

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

Note
titleSecurity Note

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

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 Mother May I - 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 Mother May I - 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

...