Request a cancellation for all unfinished jobs in a build. The build's status will not update immediately. This endpoint is asynchronous and a success response indicates that the cancellation request has been acknowledged and the build is expected to be canceled soon. If the build has already finished or finishes shortly after the request and before the cancellation, the build will not change.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:orchestration-write.
1
2
3
curl -X POST \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/orchestration/builds/ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58/cancel"| Error Name | ||
|---|---|---|
Cancel | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not cancel the Build. | |
| Parameters | buildRid | |
See Errors for a general overview of errors in the platform.