Wake up Cloud Machines via API

Cloud hosting platforms such as Azure and AWS take a few minutes to start new cloud VMs. However, if you know you are about to run a build (e.g. CLI tools), you can use our API to manually start VMs ahead of your execution to speed up your build process.

If any VMs in your pool are already started, but are inactive, Incredibuild will use these machines. The number of started VMs is limited by the number of VMs in your pool. Upon the completion of the task execution, Incredibuild Cloud will automatically stop the running VMs that were started for this task.

The API call itself is based on the coreReq parameter, which should contain the number of cores you want to start. Depending on the VM type you are using, a corresponding number of VMs will be started. For example, if you are using a VM type that has 2 cores, and you are requesting 8 cores, 4 VMs will be started.

Request Syntax

POST https://incredicloudapim-prod.azure-api.net/provision/setWakeupMachines/ HTTP/1.1
Content-type: application/json
X-IBC-SECRET: <”customer secret”> {
"coordId": "string",
"coreReq": "number"
}

Where:

customer secret :To find your Customer Secret:
- If you used full permissions when you logged in and activate the integration of Incredibuild Cloud, you can get your customer secret from the registry:
  
  HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Xoreax\Incredibuild\Coordinator\IncrediCloudSubscriptionKey
- If you used low permissions when you logged in and activate the integration of Incredibuild Cloud:
  - For AWS - this is your External ID from AWS Console. For details, see Obtaining the Required AWS Login Details.
  - For Azure – this is your Client Secret from the Azure portal. For details, see: Obtaining the Required Azure Login Details.
- coordId – your Coordinator ID. You can find this ID by going to the Incredibuild taskbar icon > Help > About and copying the License ID. This is slightly different in different versions of Incredibuild.
coreReq – the number of cores you want to start. A value of 0 will start all the VMs in the pool that are in a Stopped state, a value greater than 0 will start the specified number of cores. If the number of requested cores is lower than the number of cores in a single VM of the type you are using, the number of cores will be rounded up. For example, if you requested 24 cores, but you are using a VM type that has 32 cores, one VM with 32 cores will be started.

Response Syntax

Success
HTTP/1.1 200
Content-type: application/json
{
machinesToWakeUp : []
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response with the machinesToWakeUp - a list of the VM names that were started following your request.