Share via

Runs - Run Pipeline

Service:
Pipelines
API Version:
7.1

Runs a pipeline.

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=7.1
With optional parameters: 
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?pipelineVersion={pipelineVersion}&api-version=7.1

URI Parameters

Name In Required Type Description
organization
 path True

string

The name of the Azure DevOps organization.
pipelineId
 path True

integer (int32)

The pipeline ID.
project
 path True

string

Project ID or project name
api-version
 query True

string

Version of the API to use. This should be set to '7.1' to use this version of the api.
pipelineVersion
 query

integer (int32)

The pipeline version.

Request Body

Name Type Description
previewRun

boolean

If true, don't actually create a new run. Instead, return the final YAML document after parsing templates.
resources

RunResourcesParameters

The resources the run requires.
stagesToSkip

string[]

templateParameters

object

variables

<string,  Variable>

yamlOverride

string

If you use the preview run option, you may optionally supply different YAML. This allows you to preview the final YAML document without committing a changed file.

Responses

Name Type Description
200 OK

Run

successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name Description
vso.build_execute Grants the ability to access build artifacts, including build results, definitions, and requests, and the ability to queue a build, update build properties, and the ability to receive notifications about build events via service hooks.

Definitions

Name Description
BuildResourceParameters
Container
ContainerResource
ContainerResourceParameters
PackageResourceParameters
PipelineReference

A reference to a Pipeline.
PipelineResource
PipelineResourceParameters
ReferenceLinks

The class to represent a collection of REST reference links.
Repository
RepositoryResource
RepositoryResourceParameters
RepositoryType
Run
RunPipelineParameters

Settings which influence pipeline runs.
RunResources
RunResourcesParameters
RunResult
RunState
Variable

BuildResourceParameters

Object
Name Type Description
version

string

Container

Object
Name Type Description
environment

object

image

string

mapDockerSocket

boolean

options

string

ports

string[]

volumes

string[]

ContainerResource

Object
Name Type Description
container

Container

ContainerResourceParameters

Object
Name Type Description
version

string

PackageResourceParameters

Object
Name Type Description
version

string

PipelineReference

Object

A reference to a Pipeline.

Name Type Description
folder

string

Pipeline folder
id

integer (int32)

Pipeline ID
name

string

Pipeline name
revision

integer (int32)

Revision number
url

string

PipelineResource

Object
Name Type Description
pipeline

PipelineReference

A reference to a Pipeline.
version

string

PipelineResourceParameters

Object
Name Type Description
version

string

Object

The class to represent a collection of REST reference links.

Name Type Description
links

object

The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

Repository

Object
Name Type Description
type

RepositoryType

RepositoryResource

Object
Name Type Description
refName

string

repository

Repository

version

string

RepositoryResourceParameters

Object
Name Type Description
refName

string

token

string

This is the security token to use when connecting to the repository.
tokenType

string

Optional. This is the type of the token given. If not provided, a type of "Bearer" is assumed. Note: Use "Basic" for a PAT token.
version

string

RepositoryType

Enumeration
Value Description
unknown
gitHub
azureReposGit
gitHubEnterprise
azureReposGitHyphenated

Run

Object
Name Type Description
_links

ReferenceLinks

The class to represent a collection of REST reference links.
createdDate

string (date-time)

finalYaml

string

finishedDate

string (date-time)

id

integer (int32)

name

string

pipeline

PipelineReference

A reference to a Pipeline.
resources

RunResources

result

RunResult

state

RunState

templateParameters

object

url

string

variables

<string,  Variable>

RunPipelineParameters

Object

Settings which influence pipeline runs.

Name Type Description
previewRun

boolean

If true, don't actually create a new run. Instead, return the final YAML document after parsing templates.
resources

RunResourcesParameters

The resources the run requires.
stagesToSkip

string[]

templateParameters

object

variables

<string,  Variable>

yamlOverride

string

If you use the preview run option, you may optionally supply different YAML. This allows you to preview the final YAML document without committing a changed file.

RunResources

Object
Name Type Description
containers

<string,  ContainerResource>

pipelines

<string,  PipelineResource>

repositories

<string,  RepositoryResource>

RunResourcesParameters

Object
Name Type Description
builds

<string,  BuildResourceParameters>

containers

<string,  ContainerResourceParameters>

packages

<string,  PackageResourceParameters>

pipelines

<string,  PipelineResourceParameters>

repositories

<string,  RepositoryResourceParameters>

RunResult

Enumeration
Value Description
unknown
succeeded
failed
canceled

RunState

Enumeration
Value Description
unknown
inProgress
canceling
completed

Variable

Object
Name Type Description
isSecret

boolean

value

string