Cancel

Learn how to cancel a build.

Endpoint

DELETE  /api/v1/repos/:org/:repo/builds/:build/cancel

Permissions

COMING SOON!

Responses

Status CodeDescription
200indicates the request has succeeded
401indicates the user does not have proper permissions
404indicates that the server was unable to cancel the build
500indicates there was an error trying to cancel the build

Sample

Request

curl \
  -X DELETE \
  -H "Authorization: Bearer <token>" \
  "http://127.0.0.1:8080/api/v1/repos/github/octocat/builds/1/cancel"

Response

  "canceled build github/octocat/36"