Pipelines - Get Pipelines

Reference

Service:: Power BI REST APIs

API Version:: v1.0

Returns a list of deployment pipelines that the user has access to.

Required Scope

Pipeline.Read.All or Pipeline.ReadWrite.All

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

Responses

Name	Type	Description
200 OK	Pipelines	OK

Examples

Example

Sample request

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

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "a5ded933-57b7-41f4-b072-ed4c1f9d5824",
      "displayName": "Marketing Deployment Pipeline",
      "description": "Power BI deployment pipeline to manage marketing reports"
    }
  ]
}

Definitions

Name	Description
Pipeline	A Power BI pipeline
Pipelines	OData response wrapper for a collection of Power BI deployment pipelines
PipelineStage	A Power BI deployment pipeline stage

Pipeline

A Power BI pipeline

Name	Type	Description
description	string	The deployment pipeline description
displayName	string	The deployment pipeline display name
id	string	The deployment pipeline ID
stages	PipelineStage[]	The collection of deployment pipeline stages. Only returned when `$expand` is set to `stages` in the request.

Pipelines

OData response wrapper for a collection of Power BI deployment pipelines

Name	Type	Description
odata.context	string	OData context
value	Pipeline[]	The collection of deployment pipelines

PipelineStage

A Power BI deployment pipeline stage

Name	Type	Description
order	integer	The stage order, starting from zero.
workspaceId	string	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.

Share via