APIHub
Back to Explore

KeyVaultClient

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

Cloud
none
HTTPS
CORS: Unknown
Visit official documentation

Latency

3253ms p95

Uptime

0.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
PATCH

/certificates/issuers/{issuer-name}

Updates the specified certificate issuer.

  • issuer-name (path, required) — The name of the issuer.
  • api-version (query, required) — Client API version.
PUT

/certificates/issuers/{issuer-name}

Sets the specified certificate issuer.

  • issuer-name (path, required) — The name of the issuer.
  • api-version (query, required) — Client API version.
POST

/certificates/restore

Restores a backed up certificate to a vault.

  • api-version (query, required) — Client API version.
DELETE

/certificates/{certificate-name}

Deletes a certificate from a specified key vault.

  • certificate-name (path, required) — The name of the certificate.
  • api-version (query, required) — Client API version.
POST

/certificates/{certificate-name}/backup

Backs up the specified certificate.

  • certificate-name (path, required) — The name of the certificate.
  • api-version (query, required) — Client API version.
POST

/certificates/{certificate-name}/create

Creates a new certificate.

  • certificate-name (path, required) — The name of the certificate.
  • api-version (query, required) — Client API version.
POST

/certificates/{certificate-name}/import

Imports a certificate into a specified key vault.

  • certificate-name (path, required) — The name of the certificate.
  • api-version (query, required) — Client API version.
DELETE

/certificates/{certificate-name}/pending

Deletes the creation operation for a specific certificate.

  • certificate-name (path, required) — The name of the certificate.
  • api-version (query, required) — Client API version.
GET

/certificates/{certificate-name}/pending

Gets the creation operation of a certificate.

  • certificate-name (path, required) — The name of the certificate.
  • api-version (query, required) — Client API version.
PATCH

/certificates/{certificate-name}/pending

Updates a certificate operation.

  • certificate-name (path, required) — The name of the certificate.
  • api-version (query, required) — Client API version.
POST

/certificates/{certificate-name}/pending/merge

Merges a certificate or a certificate chain with a key pair existing on the server.

  • certificate-name (path, required) — The name of the certificate.
  • api-version (query, required) — Client API version.
GET

/certificates/{certificate-name}/policy

Lists the policy for a certificate.

  • certificate-name (path, required) — The name of the certificate in a given key vault.
  • api-version (query, required) — Client API version.
PATCH

/certificates/{certificate-name}/policy

Updates the policy for a certificate.

  • certificate-name (path, required) — The name of the certificate in the given vault.
  • api-version (query, required) — Client API version.
PATCH

/certificates/{certificate-name}/{certificate-version}

Updates the specified attributes associated with the given certificate.

  • certificate-name (path, required) — The name of the certificate in the given key vault.
  • certificate-version (path, required) — The version of the certificate.
  • api-version (query, required) — Client API version.
GET

/certificates/{certificate-name}/versions

List the versions of a certificate.

  • certificate-name (path, required) — The name of the certificate.
  • maxresults (query, limit) — Maximum number of results to return in a page. If not specified the service will return up to 25 results.
  • api-version (query, required) — Client API version.
GET

/certificates/{certificate-name}/{certificate-version}

Gets information about a certificate.

  • certificate-name (path, required) — The name of the certificate in the given vault.
  • certificate-version (path, required) — The version of the certificate.
  • api-version (query, required) — Client API version.
GET

/deletedstorage/{storage-account-name}/sas/{sas-definition-name}

Gets the specified deleted sas definition.

  • storage-account-name (path, required) — The name of the storage account.
  • sas-definition-name (path, required) — The name of the SAS definition.
  • api-version (query, required) — Client API version.
POST

/deletedstorage/{storage-account-name}/sas/{sas-definition-name}/recover

Recovers the deleted SAS definition.

  • storage-account-name (path, required) — The name of the storage account.
  • sas-definition-name (path, required) — The name of the SAS definition.
  • api-version (query, required) — Client API version.
GET

/keys

List keys in the specified vault.

  • maxresults (query, limit) — Maximum number of results to return in a page. If not specified the service will return up to 25 results.
  • api-version (query, required) — Client API version.
POST

/keys/restore

Restores a backed up key to a vault.

  • api-version (query, required) — Client API version.
DELETE

/keys/{key-name}

Deletes a key of any type from storage in Azure Key Vault.

  • key-name (path, required) — The name of the key to delete.
  • api-version (query, required) — Client API version.
PUT

/keys/{key-name}

Imports an externally created key, stores it, and returns key parameters and attributes to the client.

  • key-name (path, required) — Name for the imported key.
  • api-version (query, required) — Client API version.
POST

/keys/{key-name}/backup

Requests that a backup of the specified key be downloaded to the client.

  • key-name (path, required) — The name of the key.
  • api-version (query, required) — Client API version.
POST

/keys/{key-name}/create

Creates a new key, stores it, then returns key parameters and attributes to the client.

  • key-name (path, required) — The name for the new key. The system will generate the version name for the new key.
  • api-version (query, required) — Client API version.
GET

/certificates

List certificates in a specified key vault

  • maxresults (query, limit) — Maximum number of results to return in a page. If not specified the service will return up to 25 results.
  • includePending (query) — Specifies whether to include certificates which are not completely provisioned.
  • api-version (query, required) — Client API version.
DELETE

/certificates/contacts

Deletes the certificate contacts for a specified key vault.

  • api-version (query, required) — Client API version.
GET

/certificates/contacts

Lists the certificate contacts for a specified key vault.

  • api-version (query, required) — Client API version.
PUT

/certificates/contacts

Sets the certificate contacts for the specified key vault.

  • api-version (query, required) — Client API version.
GET

/certificates/issuers

List certificate issuers for a specified key vault.

  • maxresults (query, limit) — Maximum number of results to return in a page. If not specified the service will return up to 25 results.
  • api-version (query, required) — Client API version.
DELETE

/certificates/issuers/{issuer-name}

Deletes the specified certificate issuer.

  • issuer-name (path, required) — The name of the issuer.
  • api-version (query, required) — Client API version.
GET

/certificates/issuers/{issuer-name}

Lists the specified certificate issuer.

  • issuer-name (path, required) — The name of the issuer.
  • api-version (query, required) — Client API version.
GET

/deletedcertificates

Lists the deleted certificates in the specified vault currently available for recovery.

  • maxresults (query, limit) — Maximum number of results to return in a page. If not specified the service will return up to 25 results.
  • includePending (query) — Specifies whether to include certificates which are not completely provisioned.
  • api-version (query, required) — Client API version.
DELETE

/deletedcertificates/{certificate-name}

Permanently deletes the specified deleted certificate.

  • certificate-name (path, required) — The name of the certificate
  • api-version (query, required) — Client API version.
GET

/deletedcertificates/{certificate-name}

Retrieves information about the specified deleted certificate.

  • certificate-name (path, required) — The name of the certificate
  • api-version (query, required) — Client API version.
POST

/deletedcertificates/{certificate-name}/recover

Recovers the deleted certificate back to its current version under /certificates.

  • certificate-name (path, required) — The name of the deleted certificate
  • api-version (query, required) — Client API version.
GET

/deletedkeys

Lists the deleted keys in the specified vault.

  • maxresults (query, limit) — Maximum number of results to return in a page. If not specified the service will return up to 25 results.
  • api-version (query, required) — Client API version.
DELETE

/deletedkeys/{key-name}

Permanently deletes the specified key.

  • key-name (path, required) — The name of the key
  • api-version (query, required) — Client API version.
GET

/deletedkeys/{key-name}

Gets the public part of a deleted key.

  • key-name (path, required) — The name of the key.
  • api-version (query, required) — Client API version.
POST

/deletedkeys/{key-name}/recover

Recovers the deleted key to its latest version.

  • key-name (path, required) — The name of the deleted key.
  • api-version (query, required) — Client API version.
GET

/deletedsecrets

Lists deleted secrets for the specified vault.

  • maxresults (query, limit) — Maximum number of results to return in a page. If not specified the service will return up to 25 results.
  • api-version (query, required) — Client API version.
DELETE

/deletedsecrets/{secret-name}

Permanently deletes the specified secret.

  • secret-name (path, required) — The name of the secret.
  • api-version (query, required) — Client API version.
GET

/deletedsecrets/{secret-name}

Gets the specified deleted secret.

  • secret-name (path, required) — The name of the secret.
  • api-version (query, required) — Client API version.
POST

/deletedsecrets/{secret-name}/recover

Recovers the deleted secret to the latest version.

  • secret-name (path, required) — The name of the deleted secret.
  • api-version (query, required) — Client API version.
GET

/deletedstorage

Lists deleted storage accounts for the specified vault.

  • maxresults (query, limit) — Maximum number of results to return in a page. If not specified the service will return up to 25 results.
  • api-version (query, required) — Client API version.
DELETE

/deletedstorage/{storage-account-name}

Permanently deletes the specified storage account.

  • storage-account-name (path, required) — The name of the storage account.
  • api-version (query, required) — Client API version.
GET

/deletedstorage/{storage-account-name}

Gets the specified deleted storage account.

  • storage-account-name (path, required) — The name of the storage account.
  • api-version (query, required) — Client API version.
POST

/deletedstorage/{storage-account-name}/recover

Recovers the deleted storage account.

  • storage-account-name (path, required) — The name of the storage account.
  • api-version (query, required) — Client API version.
GET

/deletedstorage/{storage-account-name}/sas

Lists deleted SAS definitions for the specified vault and storage account.

  • storage-account-name (path, required) — The name of the storage account.
  • maxresults (query, limit) — Maximum number of results to return in a page. If not specified the service will return up to 25 results.
  • api-version (query, required) — Client API version.
GET

/keys/{key-name}/versions

Retrieves a list of individual key versions with the same key name.

  • key-name (path, required) — The name of the key.
  • maxresults (query, limit) — Maximum number of results to return in a page. If not specified the service will return up to 25 results.
  • api-version (query, required) — Client API version.
GET

/keys/{key-name}/{key-version}

Gets the public part of a stored key.

  • key-name (path, required) — The name of the key to get.
  • key-version (path, required) — Adding the version parameter retrieves a specific version of a key.
  • api-version (query, required) — Client API version.
PATCH

/keys/{key-name}/{key-version}

The update key operation changes specified attributes of a stored key and can be applied to any key type and key version stored in Azure Key Vault.

  • key-name (path, required) — The name of key to update.
  • key-version (path, required) — The version of the key to update.
  • api-version (query, required) — Client API version.
POST

/keys/{key-name}/{key-version}/decrypt

Decrypts a single block of encrypted data.

  • key-name (path, required) — The name of the key.
  • key-version (path, required) — The version of the key.
  • api-version (query, required) — Client API version.
POST

/keys/{key-name}/{key-version}/encrypt

Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.

  • key-name (path, required) — The name of the key.
  • key-version (path, required) — The version of the key.
  • api-version (query, required) — Client API version.
POST

/keys/{key-name}/{key-version}/sign

Creates a signature from a digest using the specified key.

  • key-name (path, required) — The name of the key.
  • key-version (path, required) — The version of the key.
  • api-version (query, required) — Client API version.
POST

/keys/{key-name}/{key-version}/unwrapkey

Unwraps a symmetric key using the specified key that was initially used for wrapping that key.

  • key-name (path, required) — The name of the key.
  • key-version (path, required) — The version of the key.
  • api-version (query, required) — Client API version.
POST

/keys/{key-name}/{key-version}/verify

Verifies a signature using a specified key.

  • key-name (path, required) — The name of the key.
  • key-version (path, required) — The version of the key.
  • api-version (query, required) — Client API version.
POST

/keys/{key-name}/{key-version}/wrapkey

Wraps a symmetric key using a specified key.

  • key-name (path, required) — The name of the key.
  • key-version (path, required) — The version of the key.
  • api-version (query, required) — Client API version.
GET

/secrets

List secrets in a specified key vault.

  • maxresults (query, limit) — Maximum number of results to return in a page. If not specified, the service will return up to 25 results.
  • api-version (query, required) — Client API version.
POST

/secrets/restore

Restores a backed up secret to a vault.

  • api-version (query, required) — Client API version.
DELETE

/secrets/{secret-name}

Deletes a secret from a specified key vault.

  • secret-name (path, required) — The name of the secret.
  • api-version (query, required) — Client API version.
PUT

/secrets/{secret-name}

Sets a secret in a specified key vault.

  • secret-name (path, required) — The name of the secret.
  • api-version (query, required) — Client API version.
POST

/secrets/{secret-name}/backup

Backs up the specified secret.

  • secret-name (path, required) — The name of the secret.
  • api-version (query, required) — Client API version.
GET

/secrets/{secret-name}/versions

List all versions of the specified secret.

  • secret-name (path, required) — The name of the secret.
  • maxresults (query, limit) — Maximum number of results to return in a page. If not specified, the service will return up to 25 results.
  • api-version (query, required) — Client API version.
GET

/secrets/{secret-name}/{secret-version}

Get a specified secret from a given key vault.

  • secret-name (path, required) — The name of the secret.
  • secret-version (path, required) — The version of the secret.
  • api-version (query, required) — Client API version.
PATCH

/secrets/{secret-name}/{secret-version}

Updates the attributes associated with a specified secret in a given key vault.

  • secret-name (path, required) — The name of the secret.
  • secret-version (path, required) — The version of the secret.
  • api-version (query, required) — Client API version.
GET

/storage

List storage accounts managed by the specified key vault. This operation requires the storage/list permission.

  • maxresults (query, limit) — Maximum number of results to return in a page. If not specified the service will return up to 25 results.
  • api-version (query, required) — Client API version.
POST

/storage/restore

Restores a backed up storage account to a vault.

  • api-version (query, required) — Client API version.
DELETE

/storage/{storage-account-name}

Deletes a storage account. This operation requires the storage/delete permission.

  • storage-account-name (path, required) — The name of the storage account.
  • api-version (query, required) — Client API version.
GET

/storage/{storage-account-name}

Gets information about a specified storage account. This operation requires the storage/get permission.

  • storage-account-name (path, required) — The name of the storage account.
  • api-version (query, required) — Client API version.
PATCH

/storage/{storage-account-name}

Updates the specified attributes associated with the given storage account. This operation requires the storage/set/update permission.

  • storage-account-name (path, required) — The name of the storage account.
  • api-version (query, required) — Client API version.
PUT

/storage/{storage-account-name}

Creates or updates a new storage account. This operation requires the storage/set permission.

  • storage-account-name (path, required) — The name of the storage account.
  • api-version (query, required) — Client API version.
POST

/storage/{storage-account-name}/backup

Backs up the specified storage account.

  • storage-account-name (path, required) — The name of the storage account.
  • api-version (query, required) — Client API version.
POST

/storage/{storage-account-name}/regeneratekey

Regenerates the specified key value for the given storage account. This operation requires the storage/regeneratekey permission.

  • storage-account-name (path, required) — The name of the storage account.
  • api-version (query, required) — Client API version.
GET

/storage/{storage-account-name}/sas

List storage SAS definitions for the given storage account. This operation requires the storage/listsas permission.

  • storage-account-name (path, required) — The name of the storage account.
  • maxresults (query, limit) — Maximum number of results to return in a page. If not specified the service will return up to 25 results.
  • api-version (query, required) — Client API version.
DELETE

/storage/{storage-account-name}/sas/{sas-definition-name}

Deletes a SAS definition from a specified storage account. This operation requires the storage/deletesas permission.

  • storage-account-name (path, required) — The name of the storage account.
  • sas-definition-name (path, required) — The name of the SAS definition.
  • api-version (query, required) — Client API version.
GET

/storage/{storage-account-name}/sas/{sas-definition-name}

Gets information about a SAS definition for the specified storage account. This operation requires the storage/getsas permission.

  • storage-account-name (path, required) — The name of the storage account.
  • sas-definition-name (path, required) — The name of the SAS definition.
  • api-version (query, required) — Client API version.
PATCH

/storage/{storage-account-name}/sas/{sas-definition-name}

Updates the specified attributes associated with the given SAS definition. This operation requires the storage/setsas permission.

  • storage-account-name (path, required) — The name of the storage account.
  • sas-definition-name (path, required) — The name of the SAS definition.
  • api-version (query, required) — Client API version.
PUT

/storage/{storage-account-name}/sas/{sas-definition-name}

Creates or updates a new SAS definition for the specified storage account. This operation requires the storage/setsas permission.

  • storage-account-name (path, required) — The name of the storage account.
  • sas-definition-name (path, required) — The name of the SAS definition.
  • api-version (query, required) — Client API version.

78 endpoints auto-detected

curl -X PATCH \
  "https://azure.local/certificates/issuers/{issuer-name}"

azure.local · HTTPS only