Manage Agent Pools
This article lists REST API requests concerning agent pools.
To get a list of all agent pools, use:
GET/app/rest/agentPools
The request responds with an AgentPools entity which contains instances of an AgentPool entity. The request accepts locator
parameter which should be typed as AgentPoolLocator.
For example, to get a pool named MyPool
, use:
GET/app/rest/agentPools/name:MyPool
To create an empty pool, POST an empty AgentPool entity to:
POST/app/rest/agentPools
Example payload:
<agentPool name="string"/>
{
"name" : "name"
}
To update an existing pool, PUT an updated AgentPool to this endpoint:
PUT/app/rest/agentPools/<agentPoolLocator>
To delete an agent pool, send DELETE
to this endpoint:
DELETE/app/rest/agentPools/<agentPoolLocator>
To move agent to a given pool, POST an Agent entity to this endpoint:
POST/app/rest/agentPools/<agentPoolLocator>/agents
Example payload (this will move the agent with the ID 1
to the given pool):
<agent id="1"/>
{
"id" : "1"
}
To associate a project with a given pool, POST a Project entity to the below endpoint:
POST/app/rest/agentPools/<agentPoolLocator>/projects
Example payload (this will move project with the ID MyProject
to the given pool):
<project id="MyProject"/>
{
"id" : "MyProject"
}
To remove a project from a pool, use:
DELETE /app/rest/agentPools/<agentPoolLocator>/projects/<projectLocator>
projectLocator
is typed as ProjectLocator.
Thanks for your feedback!