Synopsis
Parameters
| Parameter |
Type |
Description |
| token |
string |
Authentication token, see RemoteApi.login. |
| projectName |
string |
The name of the project that is building. |
| id |
int |
The ID of the build to kill. |
Returns
boolean: True if kill was requested, false if the build was not found or was not in progress.
Faults
| Fault Type |
Fault Reason |
| IllegalArgumentException |
If the given project name is invalid. |
Description
Request that the given active build is killed as quickly as possible. Killing does not allow for any graceful cleanup. This function returns when the request is made, which is likely to be before the build is killed.
Access
Requires administration permission for the server.
