Search documentation
karat

+

K

User Documentation ↗

Cancel Build

POST/api/v2/orchestration/builds/{buildRid}/cancel
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

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.

Path parameters

buildRid
string

The RID of a build.

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Examples

Request

Copied!
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?preview=true"