bitrise-openapi-tracker

Aborts a pipeline

POST /apps/{app-slug}/pipelines/{pipeline-id}/abort
Personal access token Addon auth token

Aborts a pipeline. You need to provide the app slug and the id of the pipeline. You can add an abort reason, choose to skip notifications and make the abort with success state.

Path parameters

  • app-slug string Required

    App slug

  • pipeline-id string Required

    Pipeline id

Body Required

Pipeline abort parameters

  • abort_reason string Required
  • abort_with_success boolean Required
  • skip_notifications boolean Required

Responses

  • 200

    OK

  • 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
  • 500

    Internal Server Error

    Hide response attribute Show response attribute object
    • message string
POST /apps/{app-slug}/pipelines/{pipeline-id}/abort 
curl \
 --request POST 'https://api.bitrise.io/v0.1/apps/{app-slug}/pipelines/{pipeline-id}/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 (400) 
{
  "message": "string"
}
Response examples (401) 
{
  "message": "string"
}
Response examples (404) 
{
  "message": "string"
}
Response examples (500) 
{
  "message": "string"
}