Azure SQL Database replication links

Name: Azure SQL Database replication links API
Brand: Azure SQL Database replication links
Availability: InStock

★ Only Publicly Available OpenAPI DocumentStorageBackup Recoveryoauth25 EndpointsREST

For Agents

Inspect, delete, and fail over per-database geo-replication links between Azure SQL primary and secondary databases.

Quickstart

Get started with Azure SQL Database replication links in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"fail over an azure sql replication link"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

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

GET STARTED

Start building with Azure SQL Database replication links API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Azure SQL Database replication links, keeping it validated and agent-ready.

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.

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

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Azure AD OAuth tokens are stored encrypted in the Jentic vault. Agents receive scoped bearer tokens at execution time — service principal client secrets never enter the agent's context.

Intent-based discovery

Agents search Jentic by intent (e.g., 'fail over a replication link') and Jentic returns the matching Microsoft.Sql replicationLinks operation with the link id schema, so the agent does not need to look up the GUID format manually.

Time to first call

Direct ARM integration: 1-3 days for AAD app registration, async polling, and replicationLinks discovery. Through Jentic: under 1 hour — search, load, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Azure SQL Database disaster recovery configurations

Server-level DR pairing rather than per-database replication links

Choose DR configuration for whole-server failover; choose replication links for per-database control

Complementary

Azure SQL Database

Manages the underlying databases that replication links connect

Use the database API to create the secondary, then use replication links to inspect or fail over the link

Complementary

Azure SQL Database backup

Manages point-in-time backups orthogonal to geo-replication

Use backup for in-place restore; use replication links for active secondary copies

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 at https://app.jentic.com/sign-up.

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 the Jentic vault 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.