Get a pipeline of a given app

GET /apps/{app-slug}/pipelines/{pipeline-id}

Get the specified pipeline of a given Bitrise app. You need to provide both an app slug and a pipeline id. You can get the pipeline id either by calling the /pipelines endpoint or by clicking on the pipeline on bitrise.io and copying the id from the URL. The endpoint returns all the relevant data of the pipeline.

Path parameters

  • app-slug string Required

    App slug

  • pipeline-id string Required

    Pipeline id

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • abort_reason string
    • app object

      Additional properties are allowed.

      Hide app attribute Show app attribute object
      • slug string
    • attempts array[object]
      Hide attempts attributes Show attempts attributes object
      • id string
      • number_in_pipeline_build_scope integer
      • status string
      • triggered_at string
    • credit_cost
    • current_attempt_id string
    • finished_at string
    • id string
    • name string
    • number_in_app_scope integer
    • put_on_hold_at
    • rebuildable boolean
    • stages array[object]
      Hide stages attributes Show stages attributes object
      • id string
      • name string
      • workflows array[object]
        Hide workflows attributes Show workflows attributes object
        • credit_cost
        • depends_on array[string]
        • external_id string
        • finished_at string
        • id string
        • name string
        • startFailureReason string
        • started_at string
        • status string
    • started_at string
    • status string

      Values are aborted, failed, initializing, on_hold, running, succeeded, or succeeded_with_abort.

    • trigger_params object

      Additional properties are allowed.

      Hide trigger_params attributes Show trigger_params attributes object
      • branch string
      • branch_dest string
      • branch_dest_repo_owner string
      • branch_repo_owner string
      • commit_hash string
      • commit_message string
      • environments array[object]
        Hide environments attributes Show environments attributes object
        • is_expand boolean
        • key string
        • value
      • pull_request_author string
      • pull_request_head_branch string
      • pull_request_id string
      • pull_request_merge_branch string
      • pull_request_repository_url string
      • pull_request_unverified_merge_branch string
      • tag string
    • triggered_at string
    • triggered_by string
    • type string
    • workflows array[object]
      Hide workflows attributes Show workflows attributes object
      • credit_cost
      • depends_on array[string]
      • external_id string
      • finished_at string
      • id string
      • name string
      • startFailureReason string
      • started_at string
      • 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
  • 500

    Internal Server Error

    Hide response attribute Show response attribute object
    • message string
GET /apps/{app-slug}/pipelines/{pipeline-id}
curl \
 --request GET 'https://api.bitrise.io/v0.1/apps/{app-slug}/pipelines/{pipeline-id}' \
 --header "Authorization: $API_KEY"
Response examples (200)
{
  "abort_reason": "string",
  "app": {
    "slug": "string"
  },
  "attempts": [
    {
      "id": "string",
      "number_in_pipeline_build_scope": 42,
      "status": "string",
      "triggered_at": "string"
    }
  ],
  "current_attempt_id": "string",
  "finished_at": "string",
  "id": "string",
  "name": "string",
  "number_in_app_scope": 42,
  "rebuildable": true,
  "stages": [
    {
      "id": "string",
      "name": "string",
      "workflows": [
        {
          "depends_on": [
            "string"
          ],
          "external_id": "string",
          "finished_at": "string",
          "id": "string",
          "name": "string",
          "startFailureReason": "string",
          "started_at": "string",
          "status": "string"
        }
      ]
    }
  ],
  "started_at": "string",
  "status": "aborted",
  "trigger_params": {
    "branch": "string",
    "branch_dest": "string",
    "branch_dest_repo_owner": "string",
    "branch_repo_owner": "string",
    "commit_hash": "string",
    "commit_message": "string",
    "environments": [
      {
        "is_expand": true,
        "key": "string"
      }
    ],
    "pull_request_author": "string",
    "pull_request_head_branch": "string",
    "pull_request_id": "string",
    "pull_request_merge_branch": "string",
    "pull_request_repository_url": "string",
    "pull_request_unverified_merge_branch": "string",
    "tag": "string"
  },
  "triggered_at": "string",
  "triggered_by": "string",
  "type": "string",
  "workflows": [
    {
      "depends_on": [
        "string"
      ],
      "external_id": "string",
      "finished_at": "string",
      "id": "string",
      "name": "string",
      "startFailureReason": "string",
      "started_at": "string",
      "status": "string"
    }
  ]
}
Response examples (400)
{
  "message": "string"
}
Response examples (401)
{
  "message": "string"
}
Response examples (404)
{
  "message": "string"
}
Response examples (500)
{
  "message": "string"
}