Gateways - Get Gateways

Returns a list of gateways for which the user is an admin.

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

Responses

Name Type Description
200 OK

OK

Examples

Example

Sample Request

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

Sample Response

{
  "value": [
    {
      "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

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

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

The list of gateways