Announcing the Availability of REST APIs for Connections and Gateways in Microsoft Fabric
We are excited to announce the preview availability of REST APIs for connections and gateways in Microsoft Fabric. These new APIs provide developers with powerful tools to programmatically manage and interact with connections and gateways within the Fabric ecosystem.
Connections REST API
The Connections REST API allows you to create, retrieve, update, and delete connections in Microsoft Fabric. Here’s an example payload of how to create a new connection using the API:
POST https://api.fabric.microsoft.com/v1/connections
{
"connectivityType": "ShareableCloud",
"displayName": "ContosoCloudConnection",
"connectionDetails": {
"type": "SQL",
"creationMethod": "SQL",
"parameters": [
{
"dataType": "Text",
"name": "server",
"value": "contoso.database.windows.net"
},
{
"dataType": "Text",
"name": "database",
"value": "sales"
}
]
},
"privacyLevel": "Organizational",
"credentialDetails": {
"singleSignOnType": "None",
"connectionEncryption": "NotEncrypted",
"skipTestConnection": false,
"credentials": {
"credentialType": "Basic",
"username": "admin",
"password": "********"
}
}
}
This API call creates a new SQL Server cloud connection named “ContosoCloudConnection” with the specified connection details.
You can use the APIs to create connections that work across cloud gateways, VNet data gateways, and on-premises data gateways.
Gateways REST API
The Gateways REST API enables you to manage data gateways, which are crucial for connecting to data sources. It includes VNet data gateways as well. Here’s an example of how to retrieve a list of gateways:
GET https://api.fabric.microsoft.com/v1/gateways
This API call returns a list of all gateways associated with your account.
Benefits of Using REST APIs
- Automation: Streamline your workflows by programmatically managing connections and gateways.
- Integration: Easily incorporate Fabric functionality into your existing applications and systems.
- Flexibility: Gain fine-grained control over your Fabric resources through API calls.
Getting Started
We encourage developers to explore the comprehensive documentation for both the Connections and Gateways REST APIs to discover the full range of available endpoints and operations.
You can also try these APIs directly through our documentation.
By leveraging these new REST APIs, you can unlock new possibilities for managing and integrating Microsoft Fabric into your data ecosystem. Happy coding!
