Microsoft Azure Azure SQL Server Backup Long Term Retention Vault
Browse all Azure APIs39
AI ReadinessNon-Ready (F)39/100
Agent-ready OpenAPI document · curated by JenticStorageBackup Recoveryoauth23 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Associate an Azure SQL server with a Recovery Services vault so backups can be retained beyond the default window.
Use for: I need to register a long-term retention vault for an Azure SQL server, List the LTR vaults attached to a SQL server, Get the named vault registration on a server, Update which Recovery Services vault stores LTR backups
Not supported: Does not trigger backups, list recovery points, or restore databases - use for registering a Recovery Services vault on a SQL server only.
Jentic publishes the only available OpenAPI specification for Azure SQL Server Backup Long Term Retention Vault, keeping it validated and agent-ready. The API associates an Azure SQL logical server with a Recovery Services vault that holds long-term retention backups, letting agents list current vault associations, retrieve a specific vault registration, or attach a new vault to a server. It targets the Microsoft.Sql resource provider on Azure Resource Manager and is intended for compliance and retention workflows that exceed the default backup window.
Install Jentic One Beta
Connect the Azure SQL Server Backup Long Term Retention Vault to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Azure SQL Server Backup Long Term Retention Vault, 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-server-backup-long-term-retention-vault" | 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-server-backup-long-term-retention-vault" | 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 Server Backup Long Term Retention Vault API.
List backup long-term retention vaults registered on a SQL server
Retrieve a specific named vault registration on a server
Register a Recovery Services vault as the LTR target for a SQL server
Update the vault used for long-term retention on a server
Audit vault registrations across servers in a subscription
Use Cases
Patterns agents use Azure SQL Server Backup Long Term Retention Vault API for, with concrete tasks.
★ Enable long-term backup retention for compliance
Register a Recovery Services vault on a SQL server so that database backups can be retained for years rather than the default 35 days. The PUT /backupLongTermRetentionVaults/{vaultName} operation associates a vault id with the server in a single call. Required for industries with long retention mandates such as financial services and healthcare.
PUT /servers/{serverName}/backupLongTermRetentionVaults/RetentionVault with the recoveryServicesVaultResourceId and verify the GET returns the new association
Compliance audit of LTR coverage
Walk every SQL server in a subscription and report which have an LTR vault registered and which fall back to the default backup window. The GET /backupLongTermRetentionVaults collection returns each server's vault association in a single call. Output supports auditor reports demonstrating retention coverage.
Iterate every SQL server in subscriptionId X, GET its backupLongTermRetentionVaults, and emit a CSV of servers without a registered vault
Re-target backups to a new vault
Move LTR backups for a server to a different Recovery Services vault, for example to consolidate vaults across regions or migrate from a legacy vault. The same PUT operation accepts the new vault id, replacing the existing association. Use during vault consolidation initiatives.
PUT /servers/{serverName}/backupLongTermRetentionVaults/RetentionVault with the new recoveryServicesVaultResourceId and verify the previous vault no longer appears in the GET list
Agent-driven retention setup
Let an AI agent register an LTR vault as part of an environment bring-up workflow without an operator hand-coding the long ARM URL. Through Jentic the agent searches by intent, loads the vault id schema, and executes the PUT. Removes a class of typos when constructing nested resource paths.
Search Jentic for 'register long term retention vault azure sql', load the vault association schema, and execute against the named server
Key Endpoints
3 endpoints — jentic publishes the only available openapi specification for azure sql server backup long term retention vault, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/backupLongTermRetentionVaults
List LTR vaults on a SQL server
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/backupLongTermRetentionVaults/{backupLongTermRetentionVaultName}
Get a named vault registration
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/backupLongTermRetentionVaults/{backupLongTermRetentionVaultName}
Register or update an LTR vault on a SQL server
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/backupLongTermRetentionVaults
List LTR vaults on a SQL server
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/backupLongTermRetentionVaults/{backupLongTermRetentionVaultName}
Get a named vault registration
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/backupLongTermRetentionVaults/{backupLongTermRetentionVaultName}
Register or update an LTR vault on a SQL server
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
A
Azure SQL Server Backup Long Term Retention Vault
- Non-Ready (F)39/100
74
Foundational Compliance55
Developer Experience & Jentic Compatibility17
AI-Readiness & Agent Experience94
Agent Usability35
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
74
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A-Signals: 4
95%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
55
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: CSignals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
25%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
93%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
17
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
69%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
0%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
35
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
35%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Azure SQL long-term retention vault API by hand means registering an Azure AD app for OAuth2 bearer auth against management.azure.com, building the nested Microsoft.Sql server path, and passing a Recovery Services vault resource id in the body while tracking the Azure-AsyncOperation header. Through Jentic you install once, import Azure SQL Server Backup Long Term Retention Vault from the API Directory, store the Azure AD credential once, and your agent calls it.
Permission scoping
The server and vault name sit in the URL path (/servers/{serverName}/backupLongTermRetentionVaults/{backupLongTermRetentionVaultName}), so a rule can pin your agent to one server's vault registration. You choose the operations it may call, so the vault-attaching PUT is not included unless you add it, leaving an agent that can only list and read registrations.
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 'register a long term retention vault for an azure sql server' or 'list the vaults on a server', and Jentic returns the matching Microsoft.Sql backupLongTermRetentionVaults operation with its vault id input schema so the agent calls the right endpoint without constructing the ARM path itself.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Azure SQL Server Backup Long Term Retention Vault API through Jentic.
Why is there no official OpenAPI spec for Azure SQL Server Backup Long Term Retention Vault?
Microsoft Azure does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Azure SQL Server Backup Long Term Retention Vault 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 this 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 exchanged for a scoped access token at execution time.
Can I register more than one vault on a server?
At this API version (2014-04-01) the backupLongTermRetentionVaults collection holds a single named registration per server, addressed as /backupLongTermRetentionVaults/{backupLongTermRetentionVaultName}. Subsequent versions of the broader long-term retention API expose richer policy controls.
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. The PUT operation may return 202 Accepted; track completion via the Azure-AsyncOperation header.
How do I register a vault through Jentic?
Run pip install jentic, then search for 'register long term retention vault azure sql'. Jentic returns the PUT /backupLongTermRetentionVaults/{name} operation, loads the recoveryServicesVaultResourceId schema, and executes against the server you specify.
Does this API trigger or restore individual backups?
No. This API only manages the vault association on a SQL server. Triggering a backup, listing recovery points, or restoring to a point in time is handled by the related backup and Recovery Services APIs.
Can I limit what my agent is allowed to do with the Azure SQL Server Backup Long Term Retention Vault API?
Yes. Because you run Jentic One yourself, your own rules decide which of the three operations the agent can reach: listing the vaults on a server, reading a named vault registration, or the PUT that registers or updates a vault. You can grant only the two read operations, so the vault-attaching PUT is not included unless you add it, leaving an agent that can only list and inspect registrations. Since the server and vault name sit in the request path, a rule can also pin the agent to a single server's vault registration.
GET STARTED