Azure Key Vault Restore API

The Restore API from Azure Key Vault — 2 operation(s) for restore.

GitHub OpenAPI

Operations 2

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

PUT /restore Restore a backed-up key vault · Full restore operation #
Ask an LLM
“How do I restore a key vault from a backup stored in Blob Storage?”
“Can I restore a key vault using a SAS token and the folder name of a previous backup?”
Tell an agent destructive · confirm first
Restore the key vault from backup folder {folder} using SAS token {sas}.
Start a full key vault restore from {folder} with SAS {sas}.
GET /restore/{jobId}/pending Check a key vault restore job · Restore status #
Ask an LLM
“Has my key vault restore job finished?”
“What is the status of a pending key vault restore?”
Tell an agent
Check the status of restore job {job}.
Show the progress of pending key vault restore {job}.

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-azure-key-vault:microsoft-azure-key-vault-restore-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-azure-key-vault-restore-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: KeyVaultClient Restore API
  version: '7.6'
  description: 'The Azure Key Vault Administration service client performs administrative operations

    including RBAC, BackupRestore, and settings management

    against the Azure Key Vault service.'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
security:
- OAuth2Auth:
  - https://vault.azure.net/.default
tags:
- name: Restore
paths:
  /restore:
    put:
      operationId: FullRestoreOperation
      description: Restores all key materials using the SAS token pointing to a previously stored Azure Blob storage backup folder
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            Azure-AsyncOperation:
              description: The URI to poll for completion status.
              schema:
                type: string
            Retry-After:
              description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestoreOperation'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestoreOperationParameters'
        description: The Azure blob SAS token pointing to a folder where the previous successful full backup was stored.
        required: true
      tags:
      - Restore
      summary: Full restore operation
      x-summary-source: derived
  /restore/{jobId}/pending:
    get:
      operationId: RestoreStatus
      description: Returns the status of restore operation
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: jobId
        in: path
        description: The Job Id returned part of the restore operation
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestoreOperation'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
      tags:
      - Restore
      summary: Restore status
      x-summary-source: derived
components:
  schemas:
    Error:
      type:
      - object
      - 'null'
      properties:
        code:
          type: string
          description: The error code.
          readOnly: true
        message:
          type: string
          description: The error message.
          readOnly: true
        innererror:
          $ref: '#/components/schemas/Error'
          description: The key vault server error.
          readOnly: true
          x-ms-client-name: innerError
    SASTokenParameter:
      type: object
      description: An authentication method and location for the operation.
      properties:
        storageResourceUri:
          type: string
          description: Azure Blob storage container Uri
        token:
          type: string
          description: The SAS token pointing to an Azure Blob storage container
        useManagedIdentity:
          type: boolean
          description: Indicates which authentication method should be used. If set to true, Managed HSM will use the configured user-assigned managed identity to authenticate with Azure Storage. Otherwise, a SAS token has to be specified.
          default: false
      required:
      - storageResourceUri
    KeyVaultError:
      type: object
      description: The key vault error exception.
      properties:
        error:
          $ref: '#/components/schemas/Error'
          description: The key vault server error.
          readOnly: true
    OperationStatus:
      type: string
      description: The status of a long-running operation.
      enum:
      - InProgress
      - Succeeded
      - Canceled
      - Failed
      x-ms-enum:
        name: OperationStatus
        modelAsString: true
        values:
        - name: InProgress
          value: InProgress
          description: The operation is in progress.
        - name: Succeeded
          value: Succeeded
          description: The operation successfully completed.
        - name: Canceled
          value: Canceled
          description: The operation was canceled.
        - name: Failed
          value: Failed
          description: The operation failed.
    RestoreOperation:
      type: object
      description: Restore operation
      properties:
        status:
          $ref: '#/components/schemas/OperationStatus'
          description: Status of the restore operation.
        statusDetails:
          type: string
          description: The status details of restore operation.
        error:
          $ref: '#/components/schemas/Error'
          description: Error encountered, if any, during the restore operation.
        jobId:
          type: string
          description: Identifier for the restore operation.
        startTime:
          type: integer
          format: unixtime
          description: The start time of the restore operation
        endTime:
          type:
          - integer
          - 'null'
          format: unixtime
          description: The end time of the restore operation
    RestoreOperationParameters:
      type: object
      description: The authentication method and location for the restore operation.
      properties:
        sasTokenParameters:
          $ref: '#/components/schemas/SASTokenParameter'
          description: A user-provided SAS token to an Azure blob storage container.
        folderToRestore:
          type: string
          description: The Folder name of the blob where the previous successful full backup was stored
      required:
      - sasTokenParameters
      - folderToRestore
  parameters:
    Azure.Core.Foundations.ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
  securitySchemes:
    OAuth2Auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            https://vault.azure.net/.default: ''
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
x-ms-parameterized-host:
  hostTemplate: '{vaultBaseUrl}'
  useSchemePrefix: false
  parameters:
  - name: vaultBaseUrl
    in: path
    description: The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)
    required: true
    type: string
    format: uri
    x-ms-skip-url-encoding: true
x-ms-paths:
  /restore/{jobId}/pending?_overload=selectiveKeyRestoreStatus:
    get:
      operationId: SelectiveKeyRestoreStatus
      description: Returns the status of the selective key restore operation
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: jobId
        in: path
        description: The Job Id returned part of the restore operation
        required: true
        type: string
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/components/schemas/SelectiveKeyRestoreOperation'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/components/schemas/KeyVaultError'