Gateways - Get Gateways
Returns a list of gateways for which the user is an admin.
The user must have gateway admin permissions.
Dataset.ReadWrite.All or Dataset.Read.All
Virtual network (VNet) gateways aren't supported.
GET https://api.powerbi.com/v1.0/myorg/gateways
Name | Type | Description |
---|---|---|
200 OK |
OK |
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="
}
}
]
}
Name | Description |
---|---|
Gateway |
A Power BI gateway |
Gateway |
A Power BI gateway public key |
Gateways |
The OData response wrapper for a list of Power BI gateways |
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 |
A Power BI gateway public key
Name | Type | Description |
---|---|---|
exponent |
string |
The public key exponent |
modulus |
string |
The public key modulus |
The OData response wrapper for a list of Power BI gateways
Name | Type | Description |
---|---|---|
odata.context |
string |
|
value |
Gateway[] |
The list of gateways |