Microsoft Azure

Azure Key Vault: Secrets

The key vault client performs cryptographic key operations and vault operations against the Key Vault service.

Identity & security#openapi#cloud

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 key vault client performs cryptographic key operations and vault operations against the Key Vault service.

Endpoints 12

Secrets

  • PUTSets a secret in a specified key vault./secrets/:secret-nameThe SET operation adds a secret to the Azure Key Vault. If the named secret already exists, Azure Key Vault creates a new version of that secret. This…
  • DELETEDeletes a secret from a specified key vault./secrets/:secret-nameThe DELETE operation applies to any secret stored in Azure Key Vault. DELETE cannot be applied to an individual version of a secret. This operation requires…
  • GETGet a specified secret from a given key vault./secrets/:secret-name/:secret-versionThe GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission.
  • PATCHUpdates the attributes associated with a specified secret in a given key vault./secrets/:secret-name/:secret-versionThe UPDATE operation changes specified attributes of an existing stored secret. Attributes that are not specified in the request are left unchanged. The value…
  • GETList secrets in a specified key vault./secrets?maxresults=1The Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response.…
  • GETList all versions of the specified secret./secrets/:secret-name/versions?maxresults=1The full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list…
  • POSTBacks up the specified secret./secrets/:secret-name/backupRequests that a backup of the specified secret be downloaded to the client. All versions of the secret will be downloaded. This operation requires the…
  • POSTRestores a backed up secret to a vault./secrets/restoreRestores a backed up secret, and all its versions, to a vault. This operation requires the secrets/restore permission.

DeletedSecrets

  • GETLists deleted secrets for the specified vault./deletedsecrets?maxresults=1The Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list…
  • GETGets the specified deleted secret./deletedsecrets/:secret-nameThe Get Deleted Secret operation returns the specified deleted secret along with its attributes. This operation requires the secrets/get permission.
  • DELETEPermanently deletes the specified secret./deletedsecrets/:secret-nameThe purge deleted secret operation removes the secret permanently, without the possibility of recovery. This operation can only be enabled on a soft-delete…
  • POSTRecovers the deleted secret to the latest version./deletedsecrets/:secret-name/recoverRecovers the deleted secret in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the…

API details

Authentication
None declared in the description
Operations
12 operations on 9 pathsGET 5POST 3DELETE 2PUT 1PATCH 1
Main resources
Secrets 8DeletedSecrets 4
Response formats
application/json
Description format
Swagger 2.0, API version 7.4

How to test the Azure Key Vault: Secrets 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: Secrets collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Sets a secret in a specified key vault.” (PUT /secrets/:secret-name), 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: Secrets?

The key vault client performs cryptographic key operations and vault operations against the Key Vault service. It is listed under Identity & security and has 12 endpoints.

Who publishes the Azure Key Vault: Secrets?

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.

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

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

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

12 operations on 9 paths (5 GET, 3 POST, 2 DELETE, 1 PUT, 1 PATCH). The largest groups are Secrets, DeletedSecrets.

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