Getting the List of Agents in a Build Group

The Groups/{Group name}/list API allows you to return a list of all the Agents in a specific Build Group.

Request Syntax

GET https://{Coordinator IP Address/Hostname}:{Web Access Port}/Groups/{Group name}/list

Where:

  • Web Access Port is the port number defined in the Coordinator Settings (default31100).

  • Group name is case sensitive.

For example:

GET https://win10-1:31100/Groups/Dev/list

Response Syntax

Returns a list of Agents (IP address and hostname) in the specified Build Group.

For example:

Copy 
[
    {
        "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 request fails if:

  • The Build Group does not include any Agents.

  • The Build Group does not exist.

When the request fails it returns: "Status": "Not found".

For example:

Copy 
[
    {
        "Group": "New",
        "Status": "Not found"
    }
]