Gateways - Get Gateway

Reference

Service:: Power BI REST APIs

API Version:: v1.0

Returns 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}

URI Parameters

Name	In	Required	Type	Description
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	Gateway	OK

Examples

Example

Sample request

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

Sample response

Status code:: 200

{
  "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

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

Share via