Microsoft Azure

Azure Key Vault: Openapi

The Azure management API provides a RESTful set of web services that interact with Azure Key Vault.

Identity & security#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Azure management API provides a RESTful set of web services that interact with Azure Key Vault.

Endpoints 48

Operations

  • GETOperations_List/providers/Microsoft.KeyVault/operationsList the operations for the provider

Vaults

  • GETVaults_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.KeyVault/vaults?$top=0The List operation gets information about the vaults associated with the subscription.
  • GETVaults_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults?$top=0The List operation gets information about the vaults associated with the subscription and within the specified resource group.
  • GETVaults_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultNameGets the specified Azure key vault.
  • PUTVaults_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultNameCreate or update a key vault in the specified subscription.
  • DELETEVaults_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultNameDeletes the specified Azure key vault.
  • PATCHVaults_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultNameUpdate a key vault in the specified subscription.
  • PUTVaults_UpdateAccessPolicy/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/accessPolicies/:operationKindUpdate access policies in a key vault in the specified subscription.
  • GETPrivateLinkResources_ListByVault/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/privateLinkResourcesGets the private link resources supported for the key vault.

DeletedVaults

  • GETVaults_GetDeleted/subscriptions/:subscriptionId/providers/Microsoft.KeyVault/locations/:location/deletedVaults/:vaultNameGets the deleted Azure key vault.
  • POSTVaults_PurgeDeleted/subscriptions/:subscriptionId/providers/Microsoft.KeyVault/locations/:location/deletedVaults/:vaultName/purgePermanently deletes the specified vault. aka Purges the deleted Azure key vault.

PrivateEndpointConnections

  • GETPrivateEndpointConnections_ListByResource/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/privateEndpointConnectionsThe List operation gets information about the private endpoint connections associated with the vault.
  • GETPrivateEndpointConnections_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/privateEndpointConnections/:privateEndpointConnectionNameGets the specified private endpoint connection associated with the key vault.
  • PUTPrivateEndpointConnections_Put/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/privateEndpointConnections/:privateEndpointConnectionNameUpdates the specified private endpoint connection associated with the key vault.
  • DELETEPrivateEndpointConnections_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/privateEndpointConnections/:privateEndpointConnectionNameDeletes the specified private endpoint connection associated with the key vault.

ManagedHsms

  • GETManagedHsms_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.KeyVault/managedHSMs?$top=0The List operation gets information about the managed HSM Pools associated with the subscription.
  • GETManagedHsms_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/managedHSMs?$top=0The List operation gets information about the managed HSM Pools associated with the subscription and within the specified resource group.
  • GETManagedHsms_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/managedHSMs/:nameGets the specified managed HSM Pool.
  • PUTManagedHsms_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/managedHSMs/:nameCreate or update a managed HSM Pool in the specified subscription.
  • DELETEManagedHsms_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/managedHSMs/:nameDeletes the specified managed HSM Pool.
  • PATCHManagedHsms_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/managedHSMs/:nameUpdate a managed HSM Pool in the specified subscription.
  • GETMHSMPrivateLinkResources_ListByMHSMResource/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/managedHSMs/:name/privateLinkResourcesGets the private link resources supported for the managed hsm pool.
  • GETMHSMRegions_ListByResource/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/managedHSMs/:name/regionsThe List operation gets information about the regions associated with the managed HSM Pool.

DeletedManagedHsms

  • GETManagedHsms_GetDeleted/subscriptions/:subscriptionId/providers/Microsoft.KeyVault/locations/:location/deletedManagedHSMs/:nameGets the specified deleted managed HSM.
  • POSTManagedHsms_PurgeDeleted/subscriptions/:subscriptionId/providers/Microsoft.KeyVault/locations/:location/deletedManagedHSMs/:name/purgePermanently deletes the specified managed HSM.

MhsmPrivateEndpointConnections

  • GETMHSMPrivateEndpointConnections_ListByResource/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/managedHSMs/:name/privateEndpointConnectionsThe List operation gets information about the private endpoint connections associated with the managed HSM Pool.
  • GETMHSMPrivateEndpointConnections_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/managedHSMs/:name/privateEndpointConnections/:privateEndpointConnectionNameGets the specified private endpoint connection associated with the managed HSM Pool.
  • PUTMHSMPrivateEndpointConnections_Put/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/managedHSMs/:name/privateEndpointConnections/:privateEndpointConnectionNameUpdates the specified private endpoint connection associated with the managed hsm pool.
  • DELETEMHSMPrivateEndpointConnections_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/managedHSMs/:name/privateEndpointConnections/:privateEndpointConnectionNameDeletes the specified private endpoint connection associated with the managed hsm pool.

Secrets

  • GETSecrets_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/secrets?$top=0The List operation gets information about the secrets in a vault. NOTE: This API is intended for internal use in ARM deployments. Users should use the…
  • GETSecrets_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/secrets/:secretNameGets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with…
  • PUTSecrets_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/secrets/:secretNameCreate or update a secret in a key vault in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the…
  • PATCHSecrets_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/secrets/:secretNameUpdate a secret in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service…

Keys

  • GETKeys_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/keysLists the keys in the specified key vault.
  • GETKeys_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/keys/:keyNameGets the current version of the specified key from the specified key vault.
  • PUTKeys_CreateIfNotExist/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/keys/:keyNameCreates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being…

KeyOperationGroup

  • GETKeys_ListVersions/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/keys/:keyName/versionsLists the keys in the specified key vault.
  • GETKeys_GetVersion/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/keys/:keyName/versions/:keyVersionGets the specified version of the specified key in the specified key vault.

ManagedHsmKeys

  • GETManagedHsmKeys_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/managedHSMs/:name/keysLists the keys in the specified managed HSM.
  • GETManagedHsmKeys_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/managedHSMs/:name/keys/:keyNameGets the current version of the specified key from the specified managed HSM.
  • PUTManagedHsmKeys_CreateIfNotExist/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/managedHSMs/:name/keys/:keyNameCreates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being…

ManagedHsmKeyOperationGroup

  • GETManagedHsmKeys_ListVersions/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/managedHSMs/:name/keys/:keyName/versionsLists the keys in the specified managed HSM.
  • GETManagedHsmKeys_GetVersion/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/managedHSMs/:name/keys/:keyName/versions/:keyVersionGets the specified version of the specified key in the specified managed HSM.
  • POSTManagedHsms_CheckMhsmNameAvailability/subscriptions/:subscriptionId/providers/Microsoft.KeyVault/checkMhsmNameAvailabilityChecks that the managed hsm name is valid and is not already in use.
  • POSTVaults_CheckNameAvailability/subscriptions/:subscriptionId/providers/Microsoft.KeyVault/checkNameAvailabilityChecks that the vault name is valid and is not already in use.
  • GETManagedHsms_ListDeleted/subscriptions/:subscriptionId/providers/Microsoft.KeyVault/deletedManagedHSMsThe List operation gets information about the deleted managed HSMs associated with the subscription.
  • GETVaults_ListDeleted/subscriptions/:subscriptionId/providers/Microsoft.KeyVault/deletedVaultsGets information about the deleted vaults in a subscription.
  • GETVaults_List/subscriptions/:subscriptionId/resources?$filter=resourceType eq 'Microsoft.KeyVault/vaults'&$top=0&api-version=2015-11-01The List operation gets information about the vaults associated with the subscription.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
48 operations on 34 pathsGET 29PUT 8POST 4DELETE 4PATCH 3
Main resources
ManagedHsms 8Vaults 8MhsmPrivateEndpointConnections 4PrivateEndpointConnections 4Secrets 4Keys 3ManagedHsmKeys 3DeletedManagedHsms 2DeletedVaults 2KeyOperationGroup 2
Response formats
application/json
Description format
Swagger 2.0, API version 2026-05-15

How to test the Azure Key Vault: Openapi in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Key Vault: Openapi collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.KeyVault/operations), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Key Vault: Openapi?

The Azure management API provides a RESTful set of web services that interact with Azure Key Vault. It is listed under Identity & security and has 48 endpoints.

Who publishes the Azure Key Vault: Openapi?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Key Vault: Openapi?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Key Vault: Openapi?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Key Vault: Openapi have?

48 operations on 34 paths (29 GET, 8 PUT, 4 POST, 4 DELETE, 3 PATCH). The largest groups are ManagedHsms, Vaults, MhsmPrivateEndpointConnections, PrivateEndpointConnections.

Is forking the Azure Key Vault: Openapi free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.