Security
All operations on this page require valid Access Tokens see Access Token Operations for more information on creating tokens.
View Agent State READ
reports the agents name, ID, build status and enabled/disabled state.
GET /rest/agents/1.0/{ID}/state?uuid={tokenId}
View Agent State - Shell Consumable Text READ
reports the agents name, ID, build status and enabled/disabled state As a file that can be consumed with a shells 'source' command.
This is useful inside a loop to wait for existing builds to finish before taking action on the host server.
GET /rest/agents/1.0/{agentId}/state/text?uuid={tokenId}
Disable Agent CHANGE
Removes the agent from the active build pool. Existing builds will complete.
POST /rest/agents/1.0/{agentId}/state/disable?uuid={tokenId}
Enable Agent CHANGE
Removes the agent from the active build pool. Existing builds will complete.
POST /rest/agents/1.0/{agentId}/state/enable?uuid={tokenId}