Configuring Your API Client Tool for Using the Build Group APIs

After you added Incredibuild self-signed certificate to your API Client tool, you need to configure it to use your Coordinator and API key. Then, you can start sending API requests to manage your Build Groups. 

Note: The following instructions describes how to configure and send the API requests using Postman.

> To configure and send Build Group API requests using Postman:

1. On Postman API Client interface, click the + button on the upper tab bar:

   

2. On the Request field, select from the drop-down list the method of the request, according to the API request syntax. For example, GET. For more information, learn about the General Syntax of Build Group APIs.

   

3. In the Enter request URL field, enter the following:

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

   Note: For more information on the general syntax of the API requests, see Exploring the General Syntax of the Build Group APIs.For example:

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

   

4. Now you need to add your API key to the HTTPS header. To perform this, click the Headers tab. Then, enter the following:

   • Key field – api-key.

   • Value field – your API key.

     

5. Your API request is ready, and you can send it by clicking the Send button.The results appear below the API request parameters: