API to monitor On-premises Data Gateway / SQL Server connection status (online/offline) in real time

[CharlieFab]

Hi all,

We’re using an On-premises data gateway with a SQL Server connection configured through it. We want to build monitoring that can check the gateway status in near real time (for example: online vs offline / unreachable).

Is there any supported API endpoint (Fabric/Power BI REST API or Gateway API) that can return:
• Gateway connection status (online/offline)
• And/or the status/health of a specific SQL Server connection configured on that gateway

Ideally we’d like something we can poll from an external monitoring tool (or integrate into our own service).

If there’s no direct “connection status” API, what’s the recommended approach for real-time monitoring (e.g., checking gateway cluster status, last heartbeat, or some other health signal)?

Thanks in advance.

[v-prasare · Accepted solution]

Your requirement is valid, but not possible today because Microsoft has not exposed a direct real-time Gateway Connection Status API. I’d encourage you to submit your detailed feedback and ideas via Microsoft's official feedback channels, such as the Microsoft Fabric Ideas

Feedback submitted here is often reviewed by the product teams and can lead to meaningful improvement. since clearer guidance would definitely help capacity administrators interpret these metrics more confidently. This helps the product group prioritize improvements, and the more customers that raise this, the faster it gets addressed.

Thanks,

Prashanth

[CharlieFab]

Thanks a lot @PR for the confirmation, Sure I will submit feedback.

[deborshi_nag]

HI @CharlieFab 

You can monitor your on-premises data gateway and its SQL Server connections using supported REST APIs.

Check Gateway Status (Online/Offline)

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

Look for the JSON field gatewayStatus (e.g., "Live" or "Offline"). This returns the cluster-level connectivity status.

Check Individual Data Source Connection Status

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

It returns a 200 OK if reachable, or a JSON error (e.g., DM_GWPipeline_Client_GatewayUnreachable) on failure.

Hope this helps - kindly appreciate giving a Kudos or accepting as a Solution! 

[CharlieFab]

Hi @deborshi_nag , I’ve already tried this approach, and it only returns the data source connection result. For example, for a SQL connection it returns 200 (“Returns the specified data source from the specified gateway”).
However, the connection I created through the primary gateway is still showing Offline in the status.

[svenchio]

Hi @CharlieFab , I'm going to answer directly your question... I'm going to assume you know how to interact with the Fabric/PowerBI API's via Postman, that is getting the token and calling interfaces, if you do not know how to do this, I recommend you to check my article Removing Orphan Fabric Deployment Pipelines and from the Solution, do Step 1: Getting the Access Token and Step 2. Configure Postman Authorization. 

Once ready, you need to get the Gateway Id via API Gateways - List Gateways - REST API (Core) | Microsoft Learn or the Fabric portal as shown below 

And once you locate the gateway Id,  you need PowerBI API interface Gateways - Get Gateways - REST API (Power BI Power BI REST APIs) | Microsoft Learn 

Example 

https://api.powerbi.com/v1.0/myorg/gateways/cbe58db1-b37e-4951-8bdf-28de8a8d2508

Result  "gatewayStatus": "Live" 

And there you have it, exactly what you need! The status of the gateway in plain site, just get the JSON response and get gatewayStatus member 😁🤞   ... I guess this is the answer for your question so, please mark as solution and a kudos would be nice ... best of lucks. 

BTW. Additional note for all the people out there, there's currently two API's that work on Fabric: 

#1. The Fabric API and

https://api.fabric.microsoft.com/v1/

#2. the PowerBI API 

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

I guesse eventually everything will be migrated to Fabric API, but until then, is worth to check on both APIs 🤞 

[CharlieFab]

Thanks, @svenchio , for the detailed explanation. I can see that it returns the gateway status, but in my scenario I need the gateway’s connection status—whether it’s online or partially online—in near real time. I don’t think there’s an API available for that.

[svenchio]

Hey @CharlieFab, most welcome on the explanatition, I'm just curious on what exactly is what you looking for 🤔 since neither mine nor @deborshi_nag  suggestions are the ones you are looking for and since an image says more than a thousend words ... is this the status you want? I mean, the on-prem gateway maching status? and if so, how is this would report anything different from? 

https://api.powerbi.com/v1.0/myorg/gateways/cbe58db1-b37e-4951-8bdf-28de8a8d2508

Just trying to understand, best of lucks 

[CharlieFab]

Hi @svenchio 

I am focusing on this connection status, I think its not the gateway cluster status, since there can be multiple connection types created from the gateway

I'm using only one On-prem Gateway and there are multiple connections with multiple connection types

I'm trying to find the Status above. In the above scenario my gateway is online but the connection status are offline for some