Run a pipeline

POST

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

Endpoint to create and initiate a pipeline. There are a number of different options to initiate a pipeline, where the payload of the request will determine which type of pipeline will be instantiated.

Trigger a pipeline for a branch

One way to trigger pipelines is by specifying the branch for which you want to trigger a pipeline. The specified branch will be used to determine which pipeline definition from the bitbucket-pipelines.yml file will be applied to initiate the pipeline. The pipeline will then do a clone of the repository and checkout the latest revision of the specified branch.

Example

$ curl -X POST -is -u '{atlassian_account_email}:{api_token}' \
      -H 'Content-Type: application/json' \
      https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines/ \
      -d '
      {
        "target": {
          "ref_type": "branch",
          "type": "pipeline_ref_target",
          "ref_name": "master"
        }
      }'

Trigger a pipeline for a commit on a branch or tag

You can initiate a pipeline for a specific commit and in the context of a specified reference (e.g. a branch, tag or bookmark). The specified reference will be used to determine which pipeline definition from the bitbucket-pipelines.yml file will be applied to initiate the pipeline. The pipeline will clone the repository and then do a checkout the specified reference.

The following reference types are supported:

branch
named_branch
bookmark
tag

Example

$ curl -X POST -is -u '{atlassian_account_email}:{api_token}' \
      -H 'Content-Type: application/json' \
      https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines/ \
      -d '
      {
        "target": {
          "commit": {
            "type": "commit",
            "hash": "ce5b7431602f7cbba007062eeb55225c6e18e956"
          },
          "ref_type": "branch",
          "type": "pipeline_ref_target",
          "ref_name": "master"
        }
      }'

Trigger a specific pipeline definition for a commit

You can trigger a specific pipeline that is defined in your bitbucket-pipelines.yml file for a specific commit. In addition to the commit revision, you specify the type and pattern of the selector that identifies the pipeline definition. The resulting pipeline will then clone the repository and checkout the specified revision.

Example

$ curl -X POST -is -u '{atlassian_account_email}:{api_token}' \
      -H 'Content-Type: application/json' \
      https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines/ \
      -d '
      {
        "target": {
          "commit": {
            "hash":"a3c4e02c9a3755eccdc3764e6ea13facdf30f923",
            "type":"commit"
          },
          "selector": {
            "type":"custom",
            "pattern":"Deploy to production"
          },
          "type":"pipeline_commit_target"
        }
      }'

Trigger a specific pipeline definition for a commit on a branch or tag

You can trigger a specific pipeline that is defined in your bitbucket-pipelines.yml file for a specific commit in the context of a specified reference. In addition to the commit revision, you specify the type and pattern of the selector that identifies the pipeline definition, as well as the reference information. The resulting pipeline will then clone the repository a checkout the specified reference.

Example

$ curl -X POST -is -u '{atlassian_account_email}:{api_token}' \
      -H 'Content-Type: application/json' \
      https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines/ \
      -d '
      {
        "target": {
          "commit": {
            "hash":"a3c4e02c9a3755eccdc3764e6ea13facdf30f923",
            "type":"commit"
          },
          "selector": {
            "type": "custom",
            "pattern": "Deploy to production"
          },
          "type": "pipeline_ref_target",
          "ref_name": "master",
          "ref_type": "branch"
        }
      }'

Trigger a custom pipeline with variables

In addition to triggering a custom pipeline that is defined in your bitbucket-pipelines.yml file as shown in the examples above, you can specify variables that will be available for your build. In the request, provide a list of variables, specifying the following for each variable: key, value, and whether it should be secured or not (this field is optional and defaults to not secured).

Example

$ curl -X POST -is -u '{atlassian_account_email}:{api_token}' \
      -H 'Content-Type: application/json' \
      https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines/ \
      -d '
      {
        "target": {
          "type": "pipeline_ref_target",
          "ref_type": "branch",
          "ref_name": "master",
          "selector": {
            "type": "custom",
            "pattern": "Deploy to production"
          }
        },
        "variables": [
          {
            "key": "var1key",
            "value": "var1value",
            "secured": true
          },
          {
            "key": "var2key",
            "value": "var2value"
          }
        ]
      }'

Trigger a pull request pipeline

You can also initiate a pipeline for a specific pull request.

Example

$ curl -X POST -is -u '{atlassian_account_email}:{api_token}' \
      -H 'Content-Type: application/json' \
      https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines/ \
      -d '
      {
        "target": {
          "type": "pipeline_pullrequest_target",
          "source": "pull-request-branch",
          "destination": "master",
          "destination_commit": {
            "hash": "9f848b7"
          },
          "commit": {
            "hash": "1a372fc"
          },
          "pullrequest": {
            "id": "3"
          },
          "selector": {
            "type": "pull-requests",
            "pattern": "**"
          }
        }
      }'

On-demand pipeline

By default, pipelines run using the YAML in the repository’s bitbucket-pipelines.yml configuration file. With an on-demand pipeline, you include the pipeline’s YAML in the request body. That YAML applies only to that run and overrides the YAML in bitbucket-pipelines.yml.

Just like with regular pipelines, there is a number of different options to initiate an on-demand pipeline. However, since the payload contains YAML configuration in this case, query parameters are used to supply the necessary metadata to determine which type of pipeline will be instantiated. These query parameters are derived from the JSON equivalent by turning each property into a key-value pair with the JSON path of the property as the new key.

Trigger on-demand pipeline for a branch

You can initiate an on-demand pipeline for a specific branch. This branch will be used to determine which pipeline definition from the supplied YAML configuration will be applied to initiate the pipeline. The pipeline will then do a clone of the repository and check out the latest revision of the specified branch.

To trigger an on-demand pipeline for a branch the requesting user must have write permission for that branch (which can be limited by branch restrictions).

Example

$ curl -X POST -is -u '{atlassian_account_email}:{api_token}' \
      -H 'Content-Type: application/yaml' \
      https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines?target.type=pipeline_ref_target&target.ref_type=branch&target.ref_name=master \
      -d '
pipelines:
  default:
    - step:
        script:
          - echo This is an on-demand pipeline'

Trigger on-demand pipeline for a commit on a branch or tag

You can initiate an on-demand pipeline for a specific commit and in the context of a specified reference (branch or tag). The specified reference will be used to determine which pipeline definition from the supplied YAML configuration will be applied to initiate the pipeline. The pipeline will clone the repository and check out the specified reference.

To trigger an on-demand pipeline for a branch the requesting user must have write permission for that branch (which can be limited by branch restrictions).

Example

$ curl -X POST -is -u '{atlassian_account_email}:{api_token}' \
      -H 'Content-Type: application/yaml' \
      https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines?target.type=pipeline_ref_target&target.ref_type=branch&target.ref_name=master&target.commit.hash=ce5b7431602f7cbba007062eeb55225c6e18e956 \
      -d '
pipelines:
  default:
    - step:
        script:
          - echo This is an on-demand pipeline'

Trigger a specific on-demand pipeline definition for a commit

You can trigger a specific pipeline that is defined in the supplied YAML configuration for a specific commit. In addition to the commit revision, you specify the type and pattern of the selector that identifies the pipeline definition. The resulting pipeline will then clone the repository and checkout the specified revision.

Example

$ curl -X POST -is -u '{atlassian_account_email}:{api_token}' \
      -H 'Content-Type: application/yaml' \
      https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines?target.type=pipeline_commit_target&target.commit.hash=a3c4e02c9a3755eccdc3764e6ea13facdf30f923&target.selector.type=custom&target.selector.pattern=security-scan \
      -d '
pipelines:
  custom:
    security-scan:
      - step:
          script:
            - echo Run on-demand security scan

Trigger a custom on-demand pipeline with variables

In addition to triggering a custom on-demand pipeline that is defined in the supplied YAML configuration as shown in the examples above, you can specify variables that will be available for your build. In the request, provide each variable as an indexed set of query parameters representing its key, value, and whether it should be secured or not (this field is optional and defaults to not secured).

Example

$ curl -X POST -is -u '{atlassian_account_email}:{api_token}' \
      -H 'Content-Type: application/yaml' \
      https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines?target.type=pipeline_ref_target&target.ref_type=branch&target.ref_name=master&target.selector.type=custom&target.selector.pattern=security-scan&variables[0].key=var1key&variables[0].value=var1value&variables[0].secured=true&variables[1].key=var2key&variables[1].value=var2value \
      -d '
pipelines:
  custom:
    security-scan:
      - variables:
          - name: var1key
          - name: var2key
      - step:
          script:
            - echo Run on-demand security scan'

Trigger a pull request pipeline

You can also initiate an on-demand pipeline for a specific pull request.

Example

$ curl -X POST -is -u '{atlassian_account_email}:{api_token}' \
      -H 'Content-Type: application/yaml' \
      https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines?target.type=pipeline_pullrequest_target&target.source=pull-request-branch&target.destination=destination&target.destination_commit.hash=9f848b7&target.commit.hash=1a372fc&target.pullrequest.id=3&target.selector.type=pull-requests&target.selector.pattern=** \
      -d '
pipelines:
  pull-requests:
    "**":
      - step:
          script:
            - echo This is an on-demand pipeline'

Authorizations

oauth2
pipeline
basic
api_key

Parameters

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.

Request Body^required

The pipeline to initiate.

application/json

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

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

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>

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

Responses

201

The initiated pipeline.

application/json

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

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

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

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

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

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>

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

Example

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

Headers

Location

string

The URL of the newly created pipeline.

400

The account or repository is not enabled, the yml file does not exist in the repository for the given revision, or the request body contained invalid properties.

application/json

Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object

type

required

string

error

object

message

required

string

detail

string

data

Optional structured data that is endpoint-specific.

object

key

additional properties

any

key

additional properties

any

Example ^generated

{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}

404

The account or repository was not found.

application/json

Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object

type

required

string

error

object

message

required

string

detail

string

data

Optional structured data that is endpoint-specific.

object

key

additional properties

any

key

additional properties

any

Example ^generated

{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}

Run a pipeline

Trigger a pipeline for a branch

Example

Trigger a pipeline for a commit on a branch or tag

Example

Trigger a specific pipeline definition for a commit

Example

Trigger a specific pipeline definition for a commit on a branch or tag

Example

Trigger a custom pipeline with variables

Example

Trigger a pull request pipeline

Example

On-demand pipeline

Trigger on-demand pipeline for a branch

Example

Trigger on-demand pipeline for a commit on a branch or tag

Example

Trigger a specific on-demand pipeline definition for a commit

Example

Trigger a custom on-demand pipeline with variables

Example

Trigger a pull request pipeline

Example

Authorizations

Parameters

Path Parameters

Request Body required

Responses

201

Example

Headers

400

Example generated

404

Example generated

Request Body^required

Example ^generated

Example ^generated