Skip to content
forgit api docs

List pipelines

GET
/repositories/{workspace}/{repo_slug}/pipelines

Find pipelines in a repository.

Note that unlike other endpoints in the Bitbucket API, this endpoint utilizes query parameters to allow filtering and sorting of returned results. See query parameters for specific details.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
workspace
required
string

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

repo_slug
required
string

The repository.

Query Parameters

Section titled “ Query Parameters ”
creator.uuid
string format: uuid

The UUID of the creator of the pipeline to filter by.

target.ref_type
string
Allowed values: BRANCH TAG ANNOTATED_TAG

The type of the reference to filter by.

target.ref_name
string

The reference name to filter by.

target.branch
string

The name of the branch to filter by.

target.commit.hash
string

The revision to filter by.

target.selector.pattern
string

The pipeline pattern to filter by.

target.selector.type
string
Allowed values: BRANCH TAG CUSTOM PULLREQUESTS DEFAULT

The type of pipeline to filter by.

created_on
string format: date-time

The creation date to filter by.

trigger_type
string
Allowed values: PUSH MANUAL SCHEDULED PARENT_STEP

The trigger type to filter by.

status
string
Allowed values: PARSING PENDING PAUSED HALTED BUILDING ERROR PASSED FAILED STOPPED UNKNOWN

The pipeline status to filter by.

sort
string
Allowed values: creator.uuid created_on run_creation_date

The attribute name to sort on.

page
integer format: int32
default: 1 >= 1

The page number of elements to retrieve.

pagelen
integer format: int32
default: 10 >= 1 <= 100

The maximum number of results to return.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

The matching pipelines.

Media type application/json
Paginated Pipelines

A paged list of pipelines

object
page

Page number of the current results. This is an optional element that is not provided in all responses.

integer
values

The values of the current page.

Array
0
object
type
required
string
uuid

The UUID identifying the pipeline.

string
build_number

The build number of the pipeline.

integer
creator
object
type
required
string
links
Account Links

Links related to an Account.

object
avatar
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
key
additional properties
any
created_on
string format: date-time
display_name
string
uuid
string
repository
object
type
required
string
links
object
self
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
html
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
avatar
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
pullrequests
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
commits
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
forks
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
watchers
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
downloads
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
clone
Array<object>
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
hooks
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
uuid

The repository’s immutable id. This can be used as a substitute for the slug segment in URLs. Doing this guarantees your URLs will survive renaming of the repository by its owner, or even transfer of the repository to a different user.

string
full_name

The concatenation of the repository owner’s username and the slugified name, e.g. “evzijst/interruptingcow”. This is the same string used in Bitbucket URLs.

string
is_private
boolean
parent
object recursive
scm
string
Allowed values: git
owner
object
type
required
string
links
Account Links

Links related to an Account.

object
avatar
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
key
additional properties
any
created_on
string format: date-time
display_name
string
uuid
string
name
string
description
string
created_on
string format: date-time
updated_on
string format: date-time
size
integer
language
string
has_issues

The issue tracker for this repository is enabled. Issue Tracker features are not supported for repositories in workspaces administered through admin.atlassian.com.

boolean
has_wiki

The wiki for this repository is enabled. Wiki features are not supported for repositories in workspaces administered through admin.atlassian.com.

boolean
fork_policy

Controls the rules for forking this repository.

  • allow_forks: unrestricted forking
  • no_public_forks: restrict forking to private forks (forks cannot be made public later)
  • no_forks: deny all forking
string
Allowed values: allow_forks no_public_forks no_forks
project
object
type
required
string
links
object
html
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
avatar
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
uuid

The project’s immutable id.

string
key

The project’s key.

string
owner
object
type
required
string
links
Account Links

Links related to an Account.

object
avatar
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
key
additional properties
any
created_on
string format: date-time
display_name
string
uuid
string
links
object
avatar
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
self
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
html
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
members
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
projects
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
repositories
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
name

The name of the project.

string
description
string
is_private

Indicates whether the project is publicly accessible, or whether it is private to the team and consequently only visible to team members. Note that private projects cannot contain public repositories.

boolean
created_on
string format: date-time
updated_on
string format: date-time
has_publicly_visible_repos

Indicates whether the project contains publicly visible repositories. Note that private projects cannot contain public repositories.

boolean
mainbranch
object
type
required
string
links
object
self
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
commits
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
html
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
name

The name of the ref.

string
target
object
type
required
string
hash
string
/[0-9a-f]{7,}?/
date
string format: date-time
author
object
type
required
string
raw

The raw author value from the repository. This may be the only value available if the author does not match a user in Bitbucket.

string
user
object
type
required
string
links
Account Links

Links related to an Account.

object
avatar
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
key
additional properties
any
created_on
string format: date-time
display_name
string
uuid
string
committer
object
type
required
string
raw

The raw committer value from the repository. This may be the only value available if the committer does not match a user in Bitbucket.

string
user
object
type
required
string
links
Account Links

Links related to an Account.

object
avatar
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
key
additional properties
any
created_on
string format: date-time
display_name
string
uuid
string
message
string
summary
object
raw

The text as it was typed by a user.

string
markup

The type of markup language the raw content is to be interpreted in.

string
Allowed values: markdown creole plaintext
html

The user’s content rendered as HTML.

string
parents
Array<object> recursive
repository
object recursive
participants
Array
0
object
type
required
string
user
object
type
required
string
links
Account Links

Links related to an Account.

object
avatar
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
key
additional properties
any
created_on
string format: date-time
display_name
string
uuid
string
role
string
Allowed values: PARTICIPANT REVIEWER
approved
boolean
state
string
Allowed values: approved changes_requested
participated_on

The ISO8601 timestamp of the participant’s action. For approvers, this is the time of their approval. For commenters and pull request reviewers who are not approvers, this is the time they last commented, or null if they have not commented.

string format: date-time
merge_strategies

Available merge strategies for pull requests targeting this branch.

Array<string>
Allowed values: merge_commit squash fast_forward squash_fast_forward rebase_fast_forward rebase_merge
default_merge_strategy

The default merge strategy for pull requests targeting this branch.

string
target
object
type
required
string
trigger
object
type
required
string
state
object
type
required
string
variables

The variables for the pipeline.

Array
0
object
type
required
string
uuid

The UUID identifying the variable.

string
key

The unique name of the variable.

string
value

The value of the variable. If the variable is secured, this will be empty.

string
secured

If true, this variable will be treated as secured. The value will never be exposed in the logs or the REST API.

boolean
created_on

The timestamp when the pipeline was created.

string format: date-time
completed_on

The timestamp when the Pipeline was completed. This is not set if the pipeline is still in progress.

string format: date-time
build_seconds_used

The number of build seconds used by this pipeline.

integer
configuration_sources

An ordered list of sources of the pipeline configuration

Array<object>
0

Information about the source of the pipeline configuration

object
source
required

Identifier of the configuration source

string
uri
required

Link to the configuration source view or its immediate content

string format: uri
links
object
type
required
string
self
object
type
required
string
href

A link

string format: uri
steps
object
type
required
string
href

A link

string format: uri
size

Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

integer
pagelen

Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

integer
next

Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

string format: uri
previous

Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

string format: uri
Example 
{
  "values": [
    {
      "repository": {
        "scm": "git",
        "fork_policy": "allow_forks",
        "mainbranch": {
          "target": {
            "summary": {
              "markup": "markdown"
            },
            "participants": [
              {
                "role": "PARTICIPANT",
                "state": "approved"
              }
            ]
          },
          "merge_strategies": [
            "merge_commit"
          ]
        }
      }
    }
  ]
}