Microsoft Azure Azure SQL Database replication links
Browse all Azure APIsAgent-ready OpenAPI document · curated by JenticStorageBackup Recoveryoauth25 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Inspect, delete, and fail over per-database geo-replication links between Azure SQL primary and secondary databases.
Use for: I need to fail over an Azure SQL database to a specific secondary, List all replication links for an Azure SQL database, Get the state of a single replication link by id, Force a database-level failover with possible data loss
Not supported: Does not handle backup, query, or schema operations - use for inspecting and failing over per-database geo-replication links only.
Jentic publishes the only available OpenAPI specification for Azure SQL Database replication links, keeping it validated and agent-ready. The API inspects and controls geo-replication links between a primary Azure SQL database and one or more secondary copies, letting agents list links, retrieve a specific link, delete it, or trigger a planned or forced failover at the database level. It targets the Microsoft.Sql resource provider on Azure Resource Manager and complements the server-level disaster recovery configuration API for finer-grained, per-database failover control.
Install Jentic One Beta
Connect the Azure SQL Database replication links to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Azure SQL Database replication links, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fazure.com%2Fazure-sql-database-replication-links" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fazure.com%2Fazure-sql-database-replication-links" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Azure SQL Database replication links API.
List all replication links on a database
Retrieve a specific replication link by id
Delete a replication link to break geo-replication
Trigger a planned failover from primary to secondary
Force a failover with potential data loss when the primary is unavailable
Inspect replication state for compliance and DR drills
Use Cases
Patterns agents use Azure SQL Database replication links API for, with concrete tasks.
★ Per-database geo-failover
Trigger a planned failover at the individual database level so a single application can switch to its secondary without affecting other databases on the same server. The POST /replicationLinks/{linkId}/failover operation switches roles for one named link, leaving sibling databases untouched. Use when applications have independent RPO/RTO targets that the server-level DR pairing cannot satisfy.
POST /databases/{databaseName}/replicationLinks/{linkId}/failover for the affected database and verify the role flips from Primary to Secondary in the subsequent GET
Replication topology audit
Walk every database on a server and list its replication links to build a topology view of primaries, secondaries, and broken pairings. The GET /replicationLinks collection returns role, partner server, and replication state for each link. This is the canonical input for DR readiness reports and post-failover reconciliation.
Iterate over every database in subscriptionId X, GET its replicationLinks, and emit a CSV grouped by partnerServer and replicationState
Forced failover during outage
Switch a database to a secondary region during an outage where the primary is unreachable, accepting that the most recent transactions may be lost. The POST /replicationLinks/{linkId}/forceFailoverAllowDataLoss operation completes the role swap without confirmation from the primary. Reserved for incident response when the planned failover path is not viable.
POST /databases/{db}/replicationLinks/{linkId}/forceFailoverAllowDataLoss and confirm the secondary now reports role Primary
Agent-driven replication management
Allow an AI agent to break or fail over a replication link in response to an alert without requiring an operator to assemble the long ARM path. Through Jentic the agent searches by intent, loads the link id schema, and executes against the right database. Removes a class of copy-paste errors common with hand-written ARM REST calls.
Search Jentic for 'fail over azure sql replication link', load the operation schema, and execute against the target database link id
Key Endpoints
5 endpoints — jentic publishes the only available openapi specification for azure sql database replication links, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks
List replication links on a database
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}
Get a specific replication link
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}
Delete a replication link
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}/failover
Trigger planned failover
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}/forceFailoverAllowDataLoss
Force failover with possible data loss
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks
List replication links on a database
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}
Get a specific replication link
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}
Delete a replication link
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}/failover
Trigger planned failover
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}/forceFailoverAllowDataLoss
Force failover with possible data loss
Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Azure SQL replication links API by hand means registering an Azure AD app for OAuth2 bearer auth against management.azure.com, building the nested Microsoft.Sql resource path down to the link GUID, and tracking the Azure-AsyncOperation header while a failover completes. Through Jentic you install once, import Azure SQL Database replication links from the API Directory, store the Azure AD credential once, and your agent calls it.
Permission scoping
The database and link id travel in the URL path (/databases/{databaseName}/replicationLinks/{linkId}), so a rule can pin your agent to one database's links. You choose the operations it may call, so destructive ones like deleting a link or forceFailoverAllowDataLoss are not included unless you add them.
Credential isolation
Your Azure AD credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'fail over an azure sql replication link' or 'list replication links for a database', and Jentic returns the matching Microsoft.Sql replicationLinks operation with its link id input schema so the agent calls the right endpoint without looking up the GUID format itself.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Azure SQL Database replication links API through Jentic.
Why is there no official OpenAPI spec for Azure SQL Database replication links?
Microsoft Azure does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Azure SQL Database replication links via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the Azure SQL Database replication links API use?
The API uses Azure AD OAuth 2.0 with the implicit flow, scoped to user_impersonation against management.azure.com. Through Jentic, the bearer token is held in your Jentic One instance and refreshed at execution time.
Can I see which replication links are active on a database?
Yes. GET /databases/{databaseName}/replicationLinks returns every link for that database with its role (Primary or Secondary), partner server, partner database, and replicationState. The single-link GET on /replicationLinks/{linkId} returns the same fields for a specific link.
What are the rate limits for this API?
Azure Resource Manager applies tenant-level throttling - typically 12,000 reads and 1,200 writes per hour per subscription. Failover operations are long-running and return 202 Accepted; track completion via the Azure-AsyncOperation header.
How do I trigger a failover through Jentic?
Run pip install jentic, then search for 'fail over azure sql replication link'. Jentic returns the POST operation on /replicationLinks/{linkId}/failover, loads the input schema, and executes with the database and link id you supply.
What is the difference between this API and the disaster recovery configuration API?
Replication links are per-database, while disasterRecoveryConfiguration is per-server. Use replication links when individual databases need independent failover; use the DR configuration API when an entire server should fail over together.
Can I limit what my agent is allowed to do with the Azure SQL Database replication links API?
Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use. Since the database and link id travel in the URL path, you can pin the agent to a single database's replication links and grant it only the read operations, such as listing links or getting one link by id. Destructive calls like deleting a link or forcing a failover with possible data loss are excluded unless you explicitly add them.
GET STARTED