Exploring the General Syntax of the Build Group APIs

The general syntax of the REST APIs, which are designed for managing Build Groups, is as follows:

METHOD https://{Coordinator IP Address/Hostname}:{Web Access Port}/{Command}

Where:

• Coordinator IP Address/Hostname – the IP address or hostname of the Coordinator, which includes the Build Groups and Agents you want to examine or manage.

• Web Access Port – the port number you defined in the Coordinator Settings dialog box for the API access. The default port number is 31100.

• Command – Incredibuild commands, specific to each API, which enables you to perform the required action.

 Important! The HTTP portion of the APIs is case sensitive. Therefore, it is important to use the commands as they are presented in the API request syntax, and to capitalize and spell the names of the Groups and Agents in exactly the same way as they appear in your system. Thus, before entering the names of Build Groups and Agents in the API commands, it is recommended to use the Groups/list and Groups/{Group name}/list APIs, in order to discover how these names are registered in your Environment.