Admin - Datasets GetDatasourcesAsAdmin

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

Returns a list of data sources for the specified dataset.

Each request takes 0.5 seconds to process, during which time other requests are queued.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required Scope

Tenant.Read.All or Tenant.ReadWrite.All 

GET https://api.powerbi.com/v1.0/myorg/admin/datasets/{datasetId}/datasources

URI Parameters

Name In Required Type Description
datasetId
 path True
  • string

Responses

Name Type Description
200 OK

OK

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/datasources

Sample Response

Status code:
200 
{
  "value": [
    {
      "name": "301",
      "connectionString": "data source=MyServer.database.windows.net;initial catalog=MyDatabase;persist security info=True;encrypt=True;trustservercertificate=False",
      "datasourceType": "Sql",
      "datasourceId": "16a54ccd-620d-4af3-9197-0b8c779a9a6d",
      "gatewayId": "7f1c4e55-544b-403f-b132-da0d3a024674",
      "connectionDetails": {
        "server": "MyServer.database.windows.net",
        "database": "MyDatabase"
      }
    }
  ]
}

Definitions

Datasource

A Power BI data source
DatasourceConnectionDetails

The Power BI data source connection details
Datasources

The OData response wrapper for a Power BI data source collection

Datasource

A Power BI data source

Name Type Description
connectionDetails

The data source connection details
connectionString
  • string

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

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

The data source type
gatewayId
  • string

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

The Power BI data source connection details

Name Type Description
database
  • string

The connection database
server
  • string

The connection server
url
  • string

The connection URL

Datasources

The OData response wrapper for a Power BI data source collection

Name Type Description
odata.context
  • string

OData context
value

The data source collection