Share via


Runs - Get

Gets a run for a particular pipeline.

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs/{runId}?api-version=6.0-preview.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

runId
path True

integer (int32)

The run id

api-version
query True

string

Version of the API to use. This should be set to '6.0-preview.1' to use this version of the api.

Responses

Name Type Description
200 OK

Run

successful operation

Security

accessToken

Personal access token. Use any value for the user name and the token as the password.

Type: basic

Definitions

Name Description
PipelineReference

A reference to a Pipeline.

ReferenceLinks

The class to represent a collection of REST reference links.

Repository
RepositoryResource
RepositoryType
Run
RunResources
RunResult
RunState
Variable

PipelineReference

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

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

Name Type Description
type

RepositoryType

RepositoryResource

Name Type Description
refName

string

repository

Repository

version

string

RepositoryType

Value Description
unknown
gitHub
azureReposGit
azureReposGitHyphenated

Run

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

url

string

variables

<string,  Variable>

RunResources

Name Type Description
repositories

<string,  RepositoryResource>

RunResult

Value Description
unknown
succeeded
failed
canceled

RunState

Value Description
unknown
inProgress
canceling
completed

Variable

Name Type Description
isSecret

boolean

value

string