Share via

Pipelines - Create Pipeline

Service:
Power BI REST APIs
API Version:
v1.0

Creates a new deployment pipeline.

Required Scope

Pipeline.ReadWrite.All 

POST https://api.powerbi.com/v1.0/myorg/pipelines

Request Body

Name Required Type Description
displayName True

string

maxLength: 256

The display name for the new deployment pipeline
description

string

maxLength: 1024

The description for the new deployment pipeline

Responses

Name Type Description
201 Created

Pipeline

Created

Examples

Create a deployment pipeline example

Sample request

POST https://api.powerbi.com/v1.0/myorg/pipelines
Request Body
{
  "displayName": "My Deployment Pipeline Name",
  "description": "My deployment pipeline description"
}

Sample response

Status code:
201 
{
  "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
  "displayName": "My Deployment Pipeline Name",
  "description": "My deployment pipeline description"
}

Definitions

Name Description
CreatePipelineRequest

A request to create a new deployment pipeline
Pipeline

A Power BI pipeline
PipelineStage

A Power BI deployment pipeline stage

CreatePipelineRequest

Object

A request to create a new deployment pipeline

Name Type Description
description

string

maxLength: 1024

The description for the new deployment pipeline
displayName

string

maxLength: 256

The display name for the new deployment pipeline

Pipeline

Object

A Power BI pipeline

Name Type Description
description

string

The deployment pipeline description
displayName

string

The deployment pipeline display name
id

string (uuid)

The deployment pipeline ID
stages

PipelineStage[]

The collection of deployment pipeline stages. Only returned when $expand is set to stages in the request.

PipelineStage

Object

A Power BI deployment pipeline stage

Name Type Description
order

integer

The stage order, starting from zero.
workspaceId

string (uuid)

The assigned workspace ID. Only applicable when there's an assigned workspace.
workspaceName

string

The assigned workspace name. Only applicable when there's an assigned workspace and the user has access to the workspace.