Abort a specific build

POST /apps/{app-slug}/builds/{build-slug}/abort

Abort a specific build. Set an abort reason with the abort_reason parameter. Use the abort_with_success parameter to abort a build but still count it as a successful one.

Path parameters

app-slug string Required

App slug
build-slug string Required

Build slug

Body Required

Build abort parameters

abort_reason string Required
abort_with_success boolean Required
skip_notifications boolean Required

Responses

200

OK
Hide response attribute Show response attribute object
- status string
400

Bad Request
Hide response attribute Show response attribute object
- message string
401

Unauthorized
Hide response attribute Show response attribute object
- message string
404

Not Found
Hide response attribute Show response attribute object
- message string
429

Too Many Requests
Hide response attribute Show response attribute object
- message string
500

Internal Server Error
Hide response attribute Show response attribute object
- message string

POST /apps/{app-slug}/builds/{build-slug}/abort

curl \
 --request POST 'https://api.bitrise.io/v0.1/apps/{app-slug}/builds/{build-slug}/abort' \
 --header "Authorization: $API_KEY" \
 --data '{"abort_reason":"string","abort_with_success":true,"skip_notifications":true}'

Request examples

{
  "abort_reason": "string",
  "abort_with_success": true,
  "skip_notifications": true
}

Response examples (200)

{
  "status": "string"
}

Response examples (400)

{
  "message": "string"
}

Response examples (401)

{
  "message": "string"
}

Response examples (404)

{
  "message": "string"
}

Response examples (429)

{
  "message": "string"
}

Response examples (500)

{
  "message": "string"
}