Microsoft Azure

Azure Key Vault

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 17

Vaults

  • GETVaults_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName?api-version=stringGets the specified Azure key vault.
  • PUTVaults_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName?api-version=stringCreate or update a key vault in the specified subscription.
  • DELETEVaults_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName?api-version=stringDeletes the specified Azure key vault.
  • PATCHVaults_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName?api-version=stringUpdate a key vault in the specified subscription.
  • PUTVaults_UpdateAccessPolicy/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/accessPolicies/:operationKind?api-version=stringUpdate access policies in a key vault in the specified subscription.
  • GETVaults_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults?$top=0&api-version=stringThe List operation gets information about the vaults associated with the subscription and within the specified resource group.
  • GETVaults_ListBySubscription/subscriptions/:subscriptionId/providers/Microsoft.KeyVault/vaults?$top=0&api-version=stringThe List operation gets information about the vaults associated with the subscription.
  • GETVaults_ListDeleted/subscriptions/:subscriptionId/providers/Microsoft.KeyVault/deletedVaults?api-version=stringGets information about the deleted vaults in a subscription.
  • GETVaults_GetDeleted/subscriptions/:subscriptionId/providers/Microsoft.KeyVault/locations/:location/deletedVaults/:vaultName?api-version=stringGets the deleted Azure key vault.
  • POSTVaults_PurgeDeleted/subscriptions/:subscriptionId/providers/Microsoft.KeyVault/locations/:location/deletedVaults/:vaultName/purge?api-version=stringPermanently deletes the specified vault. aka Purges the deleted Azure key vault.
  • 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.
  • POSTVaults_CheckNameAvailability/subscriptions/:subscriptionId/providers/Microsoft.KeyVault/checkNameAvailability?api-version=stringChecks that the vault name is valid and is not already in use.

PrivateEndpointConnections

  • GETPrivateEndpointConnections_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/privateEndpointConnections/:privateEndpointConnectionName?api-version=stringGets the specified private endpoint connection associated with the key vault.
  • PUTPrivateEndpointConnections_Put/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/privateEndpointConnections/:privateEndpointConnectionName?api-version=stringUpdates the specified private endpoint connection associated with the key vault.
  • DELETEPrivateEndpointConnections_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/privateEndpointConnections/:privateEndpointConnectionName?api-version=stringDeletes the specified private endpoint connection associated with the key vault.
  • GETPrivateEndpointConnections_ListByResource/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/privateEndpointConnections?api-version=stringThe List operation gets information about the private endpoint connections associated with the vault.

PrivateLinkResources

  • GETPrivateLinkResources_ListByVault/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName/privateLinkResources?api-version=stringGets the private link resources supported for the key vault.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
17 operations on 12 pathsGET 9PUT 3POST 2DELETE 2PATCH 1
Main resources
Vaults 12PrivateEndpointConnections 4PrivateLinkResources 1
Description format
Swagger 2.0, API version 2024-11-01

How to test the Azure Key Vault 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 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 “Vaults_Get” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.KeyVault/vaults/:vaultName?api-version=string), 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?

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 17 endpoints.

Who publishes the Azure Key Vault?

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?

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

How do I authenticate with the Azure Key Vault?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Key Vault have?

17 operations on 12 paths (9 GET, 3 PUT, 2 POST, 2 DELETE, 1 PATCH). The largest groups are Vaults, PrivateEndpointConnections, PrivateLinkResources.

Is forking the Azure Key Vault 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.