Share via

Dataflows - Get Dataflow Data Sources

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

Returns a list of data sources for the specified dataflow.

Permissions

This API call can be called by a service principal profile. For more information see: Service principal profiles in Power BI Embedded.

Required Scope

Dataflow.ReadWrite.All or Dataflow.Read.All 

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dataflows/{dataflowId}/datasources

URI Parameters

Name In Required Type Description
dataflowId
 path True

string (uuid)

The dataflow ID
groupId
 path True

string (uuid)

The workspace ID

Responses

Name Type Description
200 OK

Datasources

OK

Examples

Example

Sample request

GET https://api.powerbi.com/v1.0/myorg/groups/51e47fc5-48fd-4826-89f0-021bd3a80abd/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/datasources

Sample response

Status code:
200 
{
  "value": [
    {
      "datasourceType": "Sql",
      "datasourceId": "16a54ccd-620d-4af3-9197-0b8c779a9a6d",
      "gatewayId": "7f1c4e55-544b-403f-b132-da0d3a024674",
      "connectionDetails": {
        "server": "MyServer.database.windows.net",
        "database": "MyDatabase"
      }
    },
    {
      "datasourceType": "OData",
      "connectionDetails": {
        "url": "https://services.odata.org/V4/Northwind/Northwind.svc"
      },
      "datasourceId": "16a54ccd-620d-4af3-9197-0b8c779a9a6d",
      "gatewayId": "7f1c4e55-544b-403f-b132-da0d3a024674"
    }
  ]
}

Definitions

Name Description
Datasource

A Power BI data source
DatasourceConnectionDetails

The Power BI data source connection details. See examples in Get Datasources or Get Datasources In Group.
Datasources

The OData response wrapper for a Power BI data source collection

Datasource

Object

A Power BI data source

Name Type Description
connectionDetails

DatasourceConnectionDetails

The data source connection details
connectionString

string

(Deprecated) The data source connection string. Available only for DirectQuery.
datasourceId

string (uuid)

The bound data source ID, which is empty when not bound to a gateway
datasourceType

string

The data source type
gatewayId

string (uuid)

The bound gateway ID, which is empty when not bound to a gateway. When using a gateway cluster, the gateway ID refers to the primary (first) gateway in the cluster and is similar to the gateway cluster ID.
name

string

(Deprecated) The data source name. Available only for DirectQuery.

DatasourceConnectionDetails

Object

The Power BI data source connection details. See examples in Get Datasources or Get Datasources In Group.

Name Type Description
account

string

The connection account
classInfo

string

The connection class information
database

string

The connection database
domain

string

The connection domain
emailAddress

string

The connection email address
kind

string

The connection kind
loginServer

string

The connection login server
path

string

The connection path
server

string

The connection server
url

string

The connection URL

Datasources

Object

The OData response wrapper for a Power BI data source collection

Name Type Description
@odata.context

string

OData context
value

Datasource[]

The data source collection