The Agents/{Agent Name}
API allows you to get the details of an Agent from the Coordinator.
Request Syntax
The Agents/{Agent Name}
API request should contain the name of the Agent whose details you want to get.
GET https://{Coordinator IP Address/Hostname}:{Web Access Port}/Agents/{Agent Name}
For example:
GET https://win10-1:31100/Agents/HOST-29
Response Syntax
The Agent Details results contain the following details about the specified Agent: Build Group, IP address, name, and state.
For example:
[ { "Group": "Dev", "IP": "192.100.00.003", "Name": "HOST-29", "State": "Ready" } ]
Errors
The Agent Details request will fail if the Agent does not exist. In this case, the result is: "Status": "Not found"
.
For example:
[ { "Agent": "MyAgent", "Status": "Not found" } ]