Power BI

Power BI Gateways API

Manage on-premises data gateways and their data sources for connecting to on-premises data.

GitHub OpenAPI

Operations 3

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /gateways List on-premises gateways I administer · Power Bi List Gateways #
Ask an LLM
“Which on-premises data gateways am I an admin of?”
“Where do I find a gateway's public key for encrypting credentials?”
Tell an agent
List the gateways I administer.
Show me all my on-premises gateways with their cluster info.
GET /gateways/{gatewayId} Get one on-premises gateway · Power Bi Get a Gateway #
Ask an LLM
“How can I look up the details of one specific gateway?”
“Can I fetch a single gateway by its ID?”
Tell an agent
Get gateway {gatewayId}.
Show the details of on-premises gateway {gatewayId}.
GET /gateways/{gatewayId}/datasources List data sources on a gateway · Power Bi List Gateway Data Sources #
Ask an LLM
“Which data sources are configured on a given gateway?”
“What connections does one on-premises gateway serve?”
Tell an agent
List the data sources on gateway {gatewayId}.
Show every data source configured on gateway {gatewayId}.

Documentation

📖
Documentation
https://docs.microsoft.com/en-us/rest/api/power-bi/
📖
Authentication
https://docs.microsoft.com/en-us/power-bi/developer/embedded/get-azuread-access-token
📖
GettingStarted
https://docs.microsoft.com/en-us/power-bi/developer/embedded/embedding-content
📖
RateLimits
https://docs.microsoft.com/en-us/power-bi/developer/automation/api-rest-api-limitations
📖
Troubleshooting
https://learn.microsoft.com/en-us/power-bi/developer/embedded/troubleshoot-rest-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/power-bi/refs/heads/main/openapi/power-bi-gateways-api-openapi.yml

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/power-bi/refs/heads/main/json-ld/power-bi-rest-context.jsonld
🔗
SDKs
https://docs.microsoft.com/en-us/javascript/api/overview/powerbi/
🔗
ChangeLog
https://docs.microsoft.com/en-us/power-bi/developer/embedded/embedded-analytics-power-bi-changelog

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/power-bi:power-bi-gateways-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

power-bi-gateways-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Power BI REST Gateways API
  description: The Power BI REST API provides service endpoints for embedding, administration, governance, and user resources. It enables programmatic access to Power BI content including datasets, reports, dashboards, and workspaces (groups). The API uses Azure Active Directory (OAuth 2.0) for authentication and authorization.
  version: '1.0'
  contact:
    name: Microsoft Power BI Support
    url: https://powerbi.microsoft.com/en-us/support/
  termsOfService: https://powerbi.microsoft.com/en-us/api-terms/
  license:
    name: Microsoft API License
    url: https://powerbi.microsoft.com/en-us/terms-of-service/
servers:
- url: https://api.powerbi.com/v1.0/myorg
  description: Power BI REST API - User context
security:
- bearerAuth: []
tags:
- name: Gateways
  description: Manage on-premises data gateways and their data sources for connecting to on-premises data.
paths:
  /gateways:
    get:
      operationId: getGateways
      summary: Power Bi List Gateways
      description: Returns a list of on-premises data gateways that the user has permissions to administer. Each gateway includes its cluster information and public key for credential encryption.
      tags:
      - Gateways
      responses:
        '200':
          description: List of gateways
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayList'
              examples:
                Getgateways200Example:
                  summary: Default getGateways 200 response
                  x-microcks-default: true
                  value:
                    value:
                    - id: abc123
                      name: Example Title
                      type: Resource
                      publicKey: {}
                      gatewayAnnotation: example_value
                    '@odata.context': example_value
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Getgateways401Example:
                  summary: Default getGateways 401 response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      details:
                      - message: example_value
                        target: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /gateways/{gatewayId}:
    get:
      operationId: getGateway
      summary: Power Bi Get a Gateway
      description: Returns the specified on-premises data gateway.
      tags:
      - Gateways
      parameters:
      - $ref: '#/components/parameters/gatewayId'
      responses:
        '200':
          description: Gateway details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Gateway'
              examples:
                Getgateway200Example:
                  summary: Default getGateway 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    type: Resource
                    publicKey:
                      exponent: example_value
                      modulus: example_value
                    gatewayAnnotation: example_value
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Getgateway401Example:
                  summary: Default getGateway 401 response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      details:
                      - message: example_value
                        target: example_value
        '404':
          description: Gateway not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Getgateway404Example:
                  summary: Default getGateway 404 response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      details:
                      - message: example_value
                        target: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /gateways/{gatewayId}/datasources:
    get:
      operationId: getGatewayDatasources
      summary: Power Bi List Gateway Data Sources
      description: Returns a list of data sources configured on the specified gateway.
      tags:
      - Gateways
      parameters:
      - $ref: '#/components/parameters/gatewayId'
      responses:
        '200':
          description: List of data sources
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayDatasourceList'
              examples:
                Getgatewaydatasources200Example:
                  summary: Default getGatewayDatasources 200 response
                  x-microcks-default: true
                  value:
                    value:
                    - id: abc123
                      gatewayId: '500123'
                      datasourceType: example_value
                      connectionDetails: example_value
                      credentialType: Basic
                      datasourceName: example_value
                    '@odata.context': example_value
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Getgatewaydatasources401Example:
                  summary: Default getGatewayDatasources 401 response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      details:
                      - message: example_value
                        target: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    GatewayDatasourceList:
      type: object
      description: A list of gateway data sources
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/GatewayDatasource'
          example: []
        '@odata.context':
          type: string
          example: example_value
    GatewayList:
      type: object
      description: A list of gateways
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Gateway'
          example: []
        '@odata.context':
          type: string
          example: example_value
    GatewayDatasource:
      type: object
      description: A data source on a gateway
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier of the data source
          example: abc123
        gatewayId:
          type: string
          format: uuid
          description: The gateway this data source belongs to
          example: '500123'
        datasourceType:
          type: string
          description: The type of data source
          example: example_value
        connectionDetails:
          type: string
          description: JSON string with connection details
          example: example_value
        credentialType:
          type: string
          description: The credential type used for authentication
          enum:
          - Basic
          - Windows
          - Anonymous
          - OAuth2
          - Key
          example: Basic
        datasourceName:
          type: string
          description: The display name of the data source
          example: example_value
    Gateway:
      type: object
      description: An on-premises data gateway
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier of the gateway
          example: abc123
        name:
          type: string
          description: The display name of the gateway
          example: Example Title
        type:
          type: string
          description: The type of gateway
          enum:
          - Resource
          - Personal
          example: Resource
        publicKey:
          type: object
          description: The public key for encrypting credentials
          properties:
            exponent:
              type: string
              description: The RSA exponent
            modulus:
              type: string
              description: The RSA modulus
          example: example_value
        gatewayAnnotation:
          type: string
          description: Gateway metadata annotation
          example: example_value
    ErrorResponse:
      type: object
      description: Error response from the Power BI REST API
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code
            message:
              type: string
              description: Human-readable error message
            details:
              type: array
              description: Additional error details
              items:
                type: object
                properties:
                  message:
                    type: string
                  target:
                    type: string
          example: example_value
  parameters:
    gatewayId:
      name: gatewayId
      in: path
      required: true
      description: The unique identifier of the gateway
      schema:
        type: string
        format: uuid
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Azure Active Directory OAuth 2.0 access token. Obtain a token by registering an Azure AD application and requesting the Power BI Service scope (https://analysis.windows.net/powerbi/api/.default).
externalDocs:
  description: Power BI REST API Reference
  url: https://learn.microsoft.com/en-us/rest/api/power-bi/