Datasets - Discover Gateways In Group

Service:

Power BI REST APIs

API Version:

v1.0

Returns a list of gateways that the specified dataset from the specified workspace can be bound to.

This API call is only relevant to datasets that have at least one on-premises connection. For datasets with cloud-only connections, this API call returns an empty list.

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

Dataset.Read.All

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/Default.DiscoverGateways

URI Parameters

Name	In	Required	Type	Description
datasetId	path	True	string	The dataset ID
groupId	path	True	string uuid	The workspace ID

Responses

Name	Type	Description
200 OK	Gateways	OK

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/Default.DiscoverGateways

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "1f69e798-5852-4fdd-ab01-33bb14b6e934",
      "name": "My_Sample_Gateway",
      "type": "Resource",
      "publicKey": {
        "exponent": "AQAB",
        "modulus": "o6j2....cLk="
      }
    }
  ]
}

Definitions

Name	Description
Gateway	A Power BI gateway
GatewayPublicKey	A Power BI gateway public key
Gateways	The OData response wrapper for a list of Power BI gateways

Gateway

A Power BI gateway

Name	Type	Description
gatewayAnnotation	string	Gateway metadata in JSON format
gatewayStatus	string	The gateway connectivity status
id	string	The 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.
name	string	The gateway name
publicKey	GatewayPublicKey	The gateway public key
type	string	The gateway type

GatewayPublicKey

A Power BI gateway public key

Name	Type	Description
exponent	string	The public key exponent
modulus	string	The public key modulus

Gateways

The OData response wrapper for a list of Power BI gateways

Name	Type	Description
odata.context	string
value	Gateway[]	The list of gateways