Refresh SQL analytics endpoint Metadata REST API (Preview)
We’re excited to announce that the long-awaited refresh SQL analytics endpoint metadata REST API is now available in preview. You can now programmatically trigger a refresh of your SQL analytics endpoint to keep tables in sync with any changes made in the parent artifact, ensuring that you can keep your data up to date as needed.
To use this feature, simply pass the workspace ID, SQL analytics endpoint ID, and the API will provide detailed synchronization status for each table, including start and end times, status, last successful sync time and any error messages if applicable.
This feature offers a synchronous and asynchronous endpoint for refreshing a SQL endpoint table metadata on-demand. Its support for long-running operations allows for asynchronous processing of table refresh requests. The API also includes a timeout parameter to specify the request duration before timing out, with a default of 15 minutes. This ensures that you have the flexibility to manage your refresh processes effectively.
Here’s how you can refresh a specified SQL analytics endpoint in a workspace:
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/refreshMetadata?preview=trueSample response
[
{
"tableName": "Table 1",
"startDateTime": "2025-02-04T22:29:12.4400865Z",
"endDateTime": "2025-02-04T22:29:12.4869641Z",
"status": "Success",
"lastSuccessfulSyncDateTime": "2024-07-23T14:28:23.1864319Z"
},
{
"tableName": "Table 2",
"startDateTime": "2025-02-04T22:29:13.4400865Z",
"endDateTime": "2025-02-04T22:29:13.4869641Z",
"status": "Failure",
"error": {
"errorCode": "AdalRetryException",
"message": "Couldn't run query. There is a problem with the Microsoft Entra ID token. Have the warehouse owner log in again. If they're unavailable, use the takeover feature."
},
"lastSuccessfulSyncDateTime": "2024-07-23T14:28:23.1864319Z"
},
{
"tableName": "Table 3",
"startDateTime": "2025-02-04T22:29:14.4400865Z",
"endDateTime": "2025-02-04T22:29:14.4869641Z",
"status": "NotRun",
"lastSuccessfulSyncDateTime": "2024-07-23T14:28:23.1864319Z"
}
]
To learn more about the REST API, visit the Fabric REST APIs docs and check out this GitHub page for a code sample. We hope you find this feature provides the control you need to ensure your data is accurate and timely. As always, we welcome your feedback and look forward to hearing how you are using this feature to enhance your workflows. Please submit any feedback or suggestions at Microsoft Fabric Ideas and stay tuned for more improvements coming soon.
