The Groups/{Group name}/list API allows you to get the list of all the Agents in a certain Build Group.
Request Syntax
The Groups/{Group name}/list API request should contain the Build Group name for which you want to get the list of Agents:
GET https:// {Coordinator IP Address/Hostname}:{Web Access Port}/Groups/{Group name}/list
For example:
GET https://win10-1:31100/Groups/Dev/list
Response Syntax
The results contain the list of Agents in the specified Build Group, with their IP address and hostname.
For example:
[
{
"IP": "192.100.00.002",
"Name": "WIN10-2"
},
{
"IP": "192.100.00.001",
"Name": "WIN10-1"
},
{
"IP": "192.100.00.003",
"Name": "HOST-29"
}
]
Where:
IP– the IP address of the Agent.Name– the hostname of the Agent.
Errors
The Agent List request will fail in the following cases:
The Build Group does not include any Agents.
The Build Group does not exist.
When the Agent List request fails, the result is: "Status": "Not found".
For example:
[
{
"Group": "New",
"Status": "Not found"
}
]