Microsoft Azure

Azure Key Vault: Certificates

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

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

Endpoints 27

  • GETList certificates in a specified key vault/certificates?api-version=string&maxresults=1&includePending=trueThe GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.
  • DELETEDeletes a certificate from a specified key vault./certificates/:certificate-name?api-version=stringDeletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a…
  • GETGets information about a certificate./certificates/:certificate-name/:certificate-version?api-version=stringGets information about a specific certificate. This operation requires the certificates/get permission.
  • PATCHUpdates the specified attributes associated with the given certificate./certificates/:certificate-name/:certificate-version?api-version=stringThe UpdateCertificate operation applies the specified update on the given certificate; the only elements updated are the certificate's attributes. This…
  • POSTBacks up the specified certificate./certificates/:certificate-name/backup?api-version=stringRequests that a backup of the specified certificate be downloaded to the client. All versions of the certificate will be downloaded. This operation requires…
  • POSTCreates a new certificate./certificates/:certificate-name/create?api-version=stringIf this is the first version, the certificate resource is created. This operation requires the certificates/create permission.
  • POSTImports a certificate into a specified key vault./certificates/:certificate-name/import?api-version=stringImports an existing valid certificate, containing a private key, into Azure Key Vault. This operation requires the certificates/import permission. The…
  • GETGets the creation operation of a certificate./certificates/:certificate-name/pending?api-version=stringGets the creation operation associated with a specified certificate. This operation requires the certificates/get permission.
  • DELETEDeletes the creation operation for a specific certificate./certificates/:certificate-name/pending?api-version=stringDeletes the creation operation for a specified certificate that is in the process of being created. The certificate is no longer created. This operation…
  • PATCHUpdates a certificate operation./certificates/:certificate-name/pending?api-version=stringUpdates a certificate creation operation that is already in progress. This operation requires the certificates/update permission.
  • POSTMerges a certificate or a certificate chain with a key pair existing on the server./certificates/:certificate-name/pending/merge?api-version=stringThe MergeCertificate operation performs the merging of a certificate or certificate chain with a key pair currently available in the service. This operation…
  • GETLists the policy for a certificate./certificates/:certificate-name/policy?api-version=stringThe GetCertificatePolicy operation returns the specified certificate policy resources in the specified key vault. This operation requires the certificates/get…
  • PATCHUpdates the policy for a certificate./certificates/:certificate-name/policy?api-version=stringSet specified members in the certificate policy. Leave others as null. This operation requires the certificates/update permission.
  • GETList the versions of a certificate./certificates/:certificate-name/versions?api-version=string&maxresults=1The GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission.
  • GETLists the certificate contacts for a specified key vault./certificates/contacts?api-version=stringThe GetCertificateContacts operation returns the set of certificate contact resources in the specified key vault. This operation requires the…
  • PUTSets the certificate contacts for the specified key vault./certificates/contacts?api-version=stringSets the certificate contacts for the specified key vault. This operation requires the certificates/managecontacts permission.
  • DELETEDeletes the certificate contacts for a specified key vault./certificates/contacts?api-version=stringDeletes the certificate contacts for a specified key vault certificate. This operation requires the certificates/managecontacts permission.
  • GETList certificate issuers for a specified key vault./certificates/issuers?api-version=string&maxresults=1The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the…
  • GETLists the specified certificate issuer./certificates/issuers/:issuer-name?api-version=stringThe GetCertificateIssuer operation returns the specified certificate issuer resources in the specified key vault. This operation requires the…
  • PUTSets the specified certificate issuer./certificates/issuers/:issuer-name?api-version=stringThe SetCertificateIssuer operation adds or updates the specified certificate issuer. This operation requires the certificates/setissuers permission.
  • DELETEDeletes the specified certificate issuer./certificates/issuers/:issuer-name?api-version=stringThe DeleteCertificateIssuer operation permanently removes the specified certificate issuer from the vault. This operation requires the…
  • PATCHUpdates the specified certificate issuer./certificates/issuers/:issuer-name?api-version=stringThe UpdateCertificateIssuer operation performs an update on the specified certificate issuer entity. This operation requires the certificates/setissuers…
  • POSTRestores a backed up certificate to a vault./certificates/restore?api-version=stringRestores a backed up certificate, and all its versions, to a vault. This operation requires the certificates/restore permission.
  • GETLists the deleted certificates in the specified vault currently available for recovery./deletedcertificates?api-version=string&maxresults=1&includePending=trueThe GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This…
  • GETRetrieves information about the specified deleted certificate./deletedcertificates/:certificate-name?api-version=stringThe GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent…
  • DELETEPermanently deletes the specified deleted certificate./deletedcertificates/:certificate-name?api-version=stringThe PurgeDeletedCertificate operation performs an irreversible deletion of the specified certificate, without possibility for recovery. The operation is not…
  • POSTRecovers the deleted certificate back to its current version under /certificates./deletedcertificates/:certificate-name/recover?api-version=stringThe RecoverDeletedCertificate operation performs the reversal of the Delete operation. The operation is applicable in vaults enabled for soft-delete, and must…

API details

Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
27 operations on 17 pathsGET 10POST 6DELETE 5PATCH 4PUT 2
Response formats
application/json
Description format
Swagger 2.0, API version 7.6

How to test the Azure Key Vault: Certificates 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: Certificates 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 “List certificates in a specified key vault” (GET /certificates?api-version=string&maxresults=1&includePending=true), 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: Certificates?

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

Who publishes the Azure Key Vault: Certificates?

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: Certificates?

With OAuth 2.0 (implicit flow) with 1 scope.

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

27 operations on 17 paths (10 GET, 6 POST, 5 DELETE, 4 PATCH, 2 PUT).

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