Pipelines - Get

Service:

Pipelines

API Version:

6.0-preview.1

Gets a pipeline, optionally at the specified version

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}?api-version=6.0-preview.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}?pipelineVersion={pipelineVersion}&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
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.
pipelineVersion	query		integer (int32)	The pipeline version

Responses

Name	Type	Description
200 OK	Pipeline	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
ConfigurationType	Type of configuration.
Pipeline	Definition of a pipeline.
PipelineConfiguration
ReferenceLinks	The class to represent a collection of REST reference links.

ConfigurationType

Enumeration

Type of configuration.

Value	Description
designerHyphenJson	Designer-JSON.
designerJson	Designer JSON.
justInTime	Just-in-time.
unknown	Unknown type.
yaml	YAML.

Pipeline

Object

Definition of a pipeline.

Name	Type	Description
_links	ReferenceLinks	The class to represent a collection of REST reference links.
configuration	PipelineConfiguration
folder	string	Pipeline folder
id	integer (int32)	Pipeline ID
name	string	Pipeline name
revision	integer (int32)	Revision number
url	string	URL of the pipeline

PipelineConfiguration

Object

Name	Type	Description
type	ConfigurationType

ReferenceLinks

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.