Getting the List of Build Groups

The Groups/list API allows you to return a list of all Build Groups in a specific Coordinator, as well as the total number of Agents in each of the Build Groups.

 Request Syntax

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

Where:

For example:

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

Response Syntax

Returns a list of the Build Groups in the Coordinator, with the number of Agents in each Build Group. 

For example:

[
    {
        "AgentCount": 1,
        "Group": "Default"    },
    {
        "AgentCount": 3,
        "Group": "Dev"    },
    {
        "AgentCount": 0,
        "Group": "QA"    }
]

Where:

  • AgentCount – the number of Agents in the Build Group.

  • Group – the name of the Build Group.