Datasets - Discover Gateways

Returns a list of gateways which the specified dataset from "My Workspace" can be bound to.
This API is relevant only for datasets that have at least one on-premises connection.
For datasets with cloud-only connections, it will return an empty list.

Required scope: Dataset.Read.All
To set the permissions scope, see Register an app.

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

URI Parameters

Name In Required Type Description
datasetId
path True
  • string

The dataset id

Responses

Name Type Description
200 OK

OK

Examples

example

Sample Request

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

Sample Response

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

Definitions

Gateway

A Power BI gateway

GatewayPublicKey

A Power BI gateway public key

Gateways

Odata response wrapper for a Power BI gateways list

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

name
  • string

The gateway name

publicKey

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

Odata response wrapper for a Power BI gateways list

Name Type Description
odata.context
  • string
value

The gateways