Gateways - Get Gateway

Returns the specified gateway.

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

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

URI Parameters

Name In Required Type Description
gatewayId
path True
  • string
uuid

The gateway id

Responses

Name Type Description
200 OK

OK

Examples

example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/gateways/1f69e798-5852-4fdd-ab01-33bb14b6e934

Sample Response

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

Definitions

Gateway

A Power BI gateway

GatewayPublicKey

A Power BI gateway public key

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