Enabling the Use of Build Group APIs in the Coordinator

1. On the Coordinator machine, open the Coordinator Settings dialog box.

2. Go to Coordinator > API Access.

   

3. Select Coordinator API Access.

4. In the API Port field, enter a port number for the API communication, or use the default port number – 31100.

5. Select Require API key for access.

6. Click the Generate button to generate an API key. This is displayed in the Generate field. Copy and save this key, to use in the HTTPS header of your API requests.

7. (Optional) Select Allow Agent self registration to Build Group if you want to enable the assignment of an Agent to a Build Group during its installation or from its host machine.

8. Click OK.

Once you enabled the API access in the Coordinator, and generated an API key, the next step is to import the Incredibuild self-signed certificate to the Coordinator machine.