ATatlassian
Pipelines

List pipelines

Changed on

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.

get/repositories/{workspace}/{repo_slug}/pipelines

Request

  • Base URL
    https://api.bitbucket.org/2.0
  • URL
    https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines
  • Auth
    • OAuth 2
      Authorization code: https://bitbucket.org/site/oauth2/authorize
      Token URL: https://bitbucket.org/site/oauth2/access_token scopes: pipeline
    • or HTTP basic
    • or API key in header Authorization

Path parameters

workspacestring required

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

repo_slugstring required

The repository.

Query parameters

creator.uuidstring uuid

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

target.ref_type'BRANCH' | 'TAG' | 'ANNOTATED_TAG'

The type of the reference to filter by.

target.ref_namestring

The reference name to filter by.

target.branchstring

The name of the branch to filter by.

target.commit.hashstring

The revision to filter by.

target.selector.patternstring

The pipeline pattern to filter by.

target.selector.type'BRANCH' | 'TAG' | 'CUSTOM' | 'PULLREQUESTS' | 'DEFAULT'

The type of pipeline to filter by.

created_onstring date-time

The creation date to filter by.

trigger_type'PUSH' | 'MANUAL' | 'SCHEDULED' | 'PARENT_STEP'

The trigger type to filter by.

status'PARSING' | 'PENDING' | 'PAUSED' | 'HALTED' | 'BUILDING' | 'ERROR' | 'PASSED' | 'FAILED' | 'STOPPED' | 'UNKNOWN'

The pipeline status to filter by.

sort'creator.uuid' | 'created_on' | 'run_creation_date'

The attribute name to sort on.

pageinteger

The page number of elements to retrieve.

pageleninteger

The maximum number of results to return.

Response

The matching pipelines.

pageinteger

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

sizeinteger

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.

pageleninteger

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.

nextstring uri

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.

previousstring uri

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.

Changes

  • d344164ecb11Revision changes
    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///////////////// from the response with the status

    • warning

      removed the optional property ////////////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property ///////////// from the response with the status

    • warning

      added the new rebase_fast_forward enum value to the //////// response property for the response status

    • warning

      added the new rebase_merge enum value to the //////// response property for the response status

    • warning

      added the new squash_fast_forward enum value to the //////// response property for the response status

    • info

      added the new optional query request parameter created_on

    • info

      added the new optional query request parameter creator.uuid

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter pagelen

    • info

      added the new optional query request parameter sort

    • info

      added the new optional query request parameter status

    • info

      added the new optional query request parameter target.branch

    • info

      added the new optional query request parameter target.commit.hash

    • info

      added the new optional query request parameter target.ref_name

    • info

      added the new optional query request parameter target.ref_type

    • info

      added the new optional query request parameter target.selector.pattern

    • info

      added the new optional query request parameter target.selector.type

    • info

      added the new optional query request parameter trigger_type

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ///////////// to the response with the status