Get Secret - Get Secret

Get a specified secret from a given key vault.
The GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission.

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

URI Parameters

Name In Required Type Description
vaultBaseUrl
path True
  • string

The vault name, for example https://myvault.vault.azure.net.

secret-name
path True
  • string

The name of the secret.

secret-version
path True
  • string

The version of the secret.

api-version
query True
  • string

Client API version.

Responses

Name Type Description
200 OK

The retrieved secret.

Other Status Codes

Key Vault error response describing why the operation failed.

Examples

GetSecret

Sample Request

GET {vaultBaseUrl}/secrets/mysecretname/4387e9f3d6e14c459867679a90fd0f79?api-version=7.0

Sample Response

{
  "value": "mysecretvalue",
  "id": "https://kv-sdk-test.vault-int.azure-int.net/secrets/mysecretname/4387e9f3d6e14c459867679a90fd0f79",
  "attributes": {
    "enabled": true,
    "created": 1493938410,
    "updated": 1493938410,
    "recoverylevel": "Recoverable+Purgeable"
  }
}

Definitions

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.

KeyVaultError

The key vault error exception.

SecretAttributes

The secret management attributes.

SecretBundle

A secret consisting of a value, id and its attributes.

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
Purgeable
  • string
Recoverable
  • string
Recoverable+ProtectedSubscription
  • string
Recoverable+Purgeable
  • string

Error

The key vault server error.

Name Type Description
code
  • string

The error code.

innererror

The key vault server error.

message
  • string

The error message.

KeyVaultError

The key vault error exception.

Name Type Description
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.

recoveryLevel

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.

SecretBundle

A secret consisting of a value, id and its attributes.

Name Type Description
attributes

The secret management attributes.

contentType
  • string

The content type of the secret.

id
  • string

The secret id.

kid
  • string

If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate.

managed
  • boolean

True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true.

tags
  • object

Application specific metadata in the form of key-value pairs.

value
  • string

The secret value.