Share via

Gateways - Get Datasource

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

Returns the specified data source from the specified gateway.

Permissions

The user must have gateway admin permissions.

Required Scope

Dataset.ReadWrite.All or Dataset.Read.All

Limitations

Virtual network (VNet) gateways aren't supported. 

GET https://api.powerbi.com/v1.0/myorg/gateways/{gatewayId}/datasources/{datasourceId}

URI Parameters

Name In Required Type Description
datasourceId
 path True

string (uuid)

The data source ID
gatewayId
 path True

string (uuid)

The gateway ID. When using a gateway cluster, the gateway ID refers to the primary (first) gateway in the cluster. In such cases, gateway ID is similar to gateway cluster ID.

Responses

Name Type Description
200 OK

GatewayDatasource

OK

Examples

Example

Sample request

GET https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934/datasources/252b9de8-d915-4788-aaeb-ec8c2395f970

Sample response

Status code:
200 
{
  "id": "252b9de8-d915-4788-aaeb-ec8c2395f970",
  "gatewayId": "1f69e798-5852-4fdd-ab01-33bb14b6e934",
  "datasourceType": "Sql",
  "connectionDetails": "{\"server\":\"MyServer\",\"database\":\"MyDatabase\"}",
  "credentialType": "Windows",
  "datasourceName": "Sample Datasource"
}

Definitions

Name Description
credentialType

The type of data source credential
GatewayDatasource

A Power BI gateway data source
GatewayDatasourceCredentialDetails

The data source credential details

credentialType

Enumeration

The type of data source credential

Value Description
Basic
Windows
Anonymous
OAuth2
Key
SAS

GatewayDatasource

Object

A Power BI gateway data source

Name Type Description
connectionDetails

string

Connection details in JSON format
credentialDetails

GatewayDatasourceCredentialDetails

The connection details for the data source that needs update. The connection details are mandatory when the dataset has more than one data source.
credentialType

credentialType

The type of data source credential
datasourceName

string

The name of the data source
datasourceType

string

The type of data source.

API name for the data source
ActiveDirectory AdobeAnalytics AdoDotNet
AnalysisServices AzureBlobs AzureDataLakeStorage
AzureMarketplace AzureTables BizTalk
CDPA CustomConnector CustomHttpApi
DB2 Essbase EventHub
Excel Exchange Extension
Facebook File Folder
GoogleAnalytics Hdfs HDInsight
Informix MQ MySql
OData ODBC OleDb
Oracle PostgreSql PowerQueryMashup
PubNub Salesforce SAPBW
SAPBWMessageServer SapErp SAPHana
SharePoint SharePointDocLib SharePointList
Sql Sybase Teradata
UIFlow Web
gatewayId

string (uuid)

The associated gateway ID. 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.
id

string (uuid)

The unique ID for the data source

GatewayDatasourceCredentialDetails

Object

The data source credential details

Name Type Description
useEndUserOAuth2Credentials

boolean

Whether the end-user Azure AD identity (OAuth 2.0 credentials) is used when connecting to the data source in DirectQuery mode. Use with data sources that support single sign-on (SSO).