Get Keys - Get Keys

Reference

Service:: Key Vault

API Version:: 7.4

List keys in the specified vault.
Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all key types, however only the base key identifier, attributes, and tags are provided in the response. Individual versions of a key are not listed in the response. This operation requires the keys/list permission.

GET {vaultBaseUrl}/keys?api-version=7.4

With optional parameters:

GET {vaultBaseUrl}/keys?maxresults={maxresults}&api-version=7.4

URI Parameters

Name	In	Required	Type	Description
vaultBaseUrl	path	True	string	The vault name, for example https://myvault.vault.azure.net.
api-version	query	True	string	Client API version.
maxresults	query		integer int32	Maximum number of results to return in a page. If not specified the service will return up to 25 results.

Responses

Name	Type	Description
200 OK	KeyListResult	A response message containing a list of keys in the vault along with a link to the next page of keys.
Other Status Codes	KeyVaultError	Key Vault error response describing why the operation failed.

Examples

GetKeys

Sample Request

HTTP

GET https://myvault.vault.azure.net//keys?maxresults=1&api-version=7.4

Sample Response

Status code:: 200

{
  "value": [
    {
      "kid": "https://myvault.vault.azure.net/keys/sdktestkey",
      "attributes": {
        "enabled": true,
        "created": 1493937656,
        "updated": 1493937656,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/keys?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE5NiFNREF3TURJM0lXdGxlUzlWVUVSQlZFVkxSVmxCVkZSU1NVSlZWRVZUVkVWVFZDRXdNREF3TWpnaE1qQXhOeTB3TlMwd05GUXdNVG94TVRveE5pNDNNekE0TnpReVdpRS0iLCJUYXJnZXRMb2NhdGlvbiI6MH0&maxresults=1"
}

Definitions

Name	Description
DeletionRecoveryLevel	Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the end of the retention interval.
Error	The key vault server error.
KeyAttributes	The attributes of a key managed by the key vault service.
KeyItem	The key item containing key metadata.
KeyListResult	The key list result.
KeyVaultError	The key vault error exception.

DeletionRecoveryLevel

Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the end of the retention interval.

Name	Type	Description
CustomizedRecoverable	string	Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available.
CustomizedRecoverable+ProtectedSubscription	string	Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled.
CustomizedRecoverable+Purgeable	string	Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled.
Purgeable	string	Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)
Recoverable	string	Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered
Recoverable+ProtectedSubscription	string	Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered
Recoverable+Purgeable	string	Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered

Error

The key vault server error.

Name	Type	Description
code	string	The error code.
innererror	Error	The key vault server error.
message	string	The error message.

KeyAttributes

The attributes of a key managed by the key vault service.

Name	Type	Description
created	integer	Creation time in UTC.
enabled	boolean	Determines whether the object is enabled.
exp	integer	Expiry date in UTC.
exportable	boolean	Indicates if the private key can be exported. Release policy must be provided when creating the first version of an exportable key.
nbf	integer	Not before date in UTC.
recoverableDays	integer	softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0.
recoveryLevel	DeletionRecoveryLevel	Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the end of the retention interval.
updated	integer	Last updated time in UTC.

KeyItem

The key item containing key metadata.

Name	Type	Description
attributes	KeyAttributes	The key management attributes.
kid	string	Key identifier.
managed	boolean	True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true.
tags	object	Application specific metadata in the form of key-value pairs.

KeyListResult

The key list result.

Name	Type	Description
nextLink	string	The URL to get the next set of keys.
value	KeyItem[]	A response message containing a list of keys in the key vault along with a link to the next page of keys.

KeyVaultError

The key vault error exception.

Name	Type	Description
error	Error	The key vault server error.