Azure Key Vault

Azure Key Vault Settings API

The Settings API from Azure Key Vault — 2 operation(s) for settings.

GitHub OpenAPI

Operations 3

GET /settings List account settings #
GET /settings/{setting-name} Get specified account setting object #
PATCH /settings/{setting-name} Updates key vault account setting, stores it, then returns the setting name and… #

Documentation

📖
Documentation
https://docs.microsoft.com/en-us/azure/key-vault/
📖
GettingStarted
https://docs.microsoft.com/en-us/azure/key-vault/general/overview
📖
Authentication
https://docs.microsoft.com/en-us/azure/key-vault/general/authentication
📖
BestPractices
https://docs.microsoft.com/en-us/azure/key-vault/general/best-practices
📖
Documentation
https://docs.microsoft.com/en-us/rest/api/keyvault/
📖
APIReference
https://learn.microsoft.com/en-us/rest/api/keyvault/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/microsoft-azure-key-vault/openapi/microsoft-azure-key-vault-settings-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-key-vault/json-schema/azure-key-vault-data-plane-error-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-key-vault/json-schema/azure-key-vault-data-plane-key-vault-error-schema.json

Other Resources

🔗
Pricing
https://azure.microsoft.com/en-us/pricing/details/key-vault/
🔗
Security
https://learn.microsoft.com/en-us/azure/key-vault/general/secure-key-vault
🔗
JSONLD
https://artifacts.apis.io/microsoft-azure-key-vault/json-ld/azure-key-vault-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/microsoft-azure-key-vault/json-ld/azure-key-vault-data-plane-context.jsonld
🔗
SDKs
https://learn.microsoft.com/en-us/dotnet/api/overview/azure/security.keyvault.keys-readme
🔗
SDKs
https://learn.microsoft.com/en-us/python/api/overview/azure/keyvault-keys-readme
🔗
SDKs
https://learn.microsoft.com/en-us/java/api/overview/azure/security-keyvault-keys-readme
🔗
SDKs
https://learn.microsoft.com/en-us/javascript/api/overview/azure/keyvault-keys-readme

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-settings-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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

microsoft-azure-key-vault-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: KeyVaultClient Settings 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: Settings
paths:
  /settings:
    get:
      operationId: GetSettings
      summary: List account settings
      description: Retrieves a list of all the available account settings that can be configured.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
      tags:
      - Settings
  /settings/{setting-name}:
    get:
      operationId: GetSetting
      summary: Get specified account setting object
      description: Retrieves the setting object of a specified setting name.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/components/parameters/SettingNameParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Setting'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
      tags:
      - Settings
    patch:
      operationId: UpdateSetting
      summary: Updates key vault account setting, stores it, then returns the setting name and…
      description: Description of the pool setting to be updated
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/components/parameters/SettingNameParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Setting'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSettingRequest'
        description: The parameters to update an account setting.
        required: true
      tags:
      - Settings
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
    SettingTypeEnum:
      type: string
      description: The type specifier of the value.
      enum:
      - boolean
      x-ms-enum:
        name: SettingTypeEnum
        modelAsString: true
        values:
        - name: boolean
          value: boolean
          description: A boolean setting value.
    KeyVaultError:
      type: object
      description: The key vault error exception.
      properties:
        error:
          $ref: '#/components/schemas/Error'
          description: The key vault server error.
          readOnly: true
    SettingsListResult:
      type: object
      description: The settings list result.
      properties:
        settings:
          type: array
          description: A response message containing a list of account settings with their associated value.
          items:
            $ref: '#/components/schemas/Setting'
          readOnly: true
    Setting:
      type: object
      description: A Key Vault account setting.
      properties:
        name:
          type: string
          description: The account setting to be updated
        value:
          type: string
          description: The value of the pool setting.
        type:
          $ref: '#/components/schemas/SettingTypeEnum'
          description: The type specifier of the value.
      required:
      - name
      - value
    UpdateSettingRequest:
      type: object
      description: The update settings request object.
      properties:
        value:
          type: string
          description: The value of the pool setting.
      required:
      - value
  parameters:
    SettingNameParameter:
      name: setting-name
      in: path
      description: The name of the account setting. Must be a valid settings option.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    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'