Gateways - Get Datasource Status

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

Checks the connectivity status of the specified data source from the specified gateway.

Permissions

The user must have gateway admin permissions.

Required Scope

Dataset.ReadWrite.All

Limitations

Virtual network (VNet) gateways aren't supported. 

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

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

OK

Examples

Gateway unreachable example

Sample Request

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

Sample Response

Status code:
400 
{
  "error": {
    "code": "DM_GWPipeline_Client_GatewayUnreachable",
    "pbi.error": {
      "code": "DM_GWPipeline_Client_GatewayUnreachable",
      "parameters": {},
      "details": [],
      "exceptionCulprit": 1
    }
  }
}