Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 tool. You can use this example to configure and send requests with any other API Client tool.

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

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

    Image Removed
  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.
    Note: The syntax of each API request is described in Using REST APIs for Managing Build Groups and Agents.

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

    Code Block
    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:

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

    Image Removed

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

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

    Image Removed

...