Get Secret Versions - Get Secret Versions

Reference

Service:: Key Vault

API Version:: 7.4

List all versions of the specified secret.
The full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list permission.

GET {vaultBaseUrl}/secrets/{secret-name}/versions?api-version=7.4

With optional parameters:

GET {vaultBaseUrl}/secrets/{secret-name}/versions?maxresults={maxresults}&api-version=7.4

URI Parameters

Name	In	Required	Type	Description
secret-name	path	True	string	The name of the secret.
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	SecretListResult	A response message containing a list of secrets along with a link to the next page of secrets.
Other Status Codes	KeyVaultError	Key Vault error response describing why the operation failed.

Examples

GetSecretVersions

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "https://myvault.vault.azure.net/secrets/listsecretversionstest/11a536561da34d6b8b452d880df58f3a",
      "attributes": {
        "enabled": true,
        "created": 1481851699,
        "updated": 1481851699
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/secrets/listsecretversionstest/versions?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExNDQhTURBd01EWXlJWE5sWTNKbGRDOU1TVk5VVTBWRFVrVlVWa1ZTVTBsUFRsTlVSVk5VTHpGRU5EazJNa0l4UlVRM09EUkVRa1k0T1RsR016TXpNa1UwTnpZNFFqY3dJVEF3TURBeU9DRTVPVGs1TFRFeUxUTXhWREl6T2pVNU9qVTVMams1T1RrNU9UbGFJUS0tIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1"
}

Definitions

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

DeletionRecoveryLevel

Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, 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.

KeyVaultError

The key vault error exception.

Name	Type	Description
error	Error	The key vault server error.

SecretAttributes

The secret management attributes.

Name	Type	Description
created	integer	Creation time in UTC.
enabled	boolean	Determines whether the object is enabled.
exp	integer	Expiry date in UTC.
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 secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval.
updated	integer	Last updated time in UTC.

SecretItem

The secret item containing secret metadata.

Name	Type	Description
attributes	SecretAttributes	The secret management attributes.
contentType	string	Type of the secret value such as a password.
id	string	Secret identifier.
managed	boolean	True if the secret'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.

SecretListResult

The secret list result.

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