Clearing a Build Group - IncrediBuild Documentation

The Groups/{Group name}/clear API allows you to remove all the assigned Agents from a certain Build Group, and to move these Agent to the Default Build Group. You cannot perform the Clear action, if one or more Agents in the specified Build Group are currently participating in a build execution. Note: If an Agent in the specified Build Group is offline, the Clear action appears to be successful, but the offline Agent remains in the original Build Group. Request Syntax GET https://{Coordinator IP Address/Hostame}:{Web Access Port}/Groups/{Group Name}/clear For example:

https://win10-1:31100/Groups/Dev/clear

Response Syntax When the Agents are removed from the specified Build Group, the result is: “Status”: “Was cleaned”. For example:

[
    {
        "Group": "Dev",
        "Status": "Was cleaned"
    }
]

Errors The action fails if:

The Build Group does not include any Agents.
The Build Group does not exist.
One or more Agents in the Build Group is currently participating in a build execution.

When the action fails, the result is: “Status”: “Not found”. For example:

[
    {
        "Group": "QA",
        "Status": "Not found"
    }
]