Get Secret

Service:
Key Vault
API Version:
2016-10-01

Get a specified secret from a given key vault.

The GET operation is applicable to any secret stored in Azure Key Vault.

See Common parameters and headers for headers and parameters that are used by all requests.

In your request:

  • Replace {secret-name} with the name and {secret-version} with the version of the secret you want to retrieve. Secret version may be excluded in which case the current version is retrieved.

Request Body - None, this is an HTTP GET operation.

For more information, see About keys, secrets, and certificates and Authentication, requests, and responses.

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

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

Use the latest service version, 2016-10-01.

Responses

Name Type Description
200 OK

The retrieved secret.
Other Status Codes

Key Vault error response describing why the operation failed.

Definitions

Error

The key vault server error.
KeyVaultError
SecretAttributes

The secret management attributes.
SecretBundle

The key vault server error.

Name Type Description
code
  • string

The error code.
innererror
message
  • string

The error message.
Name Type Description
error

The key vault server error.

The secret management attributes.

Name Type Description
created
  • integer
    unixtime

Creation time in UTC.
enabled
  • boolean

Determines whether the object is enabled.
exp
  • integer
    unixtime

Expiry date in UTC.
nbf
  • integer
    unixtime

Not before date in UTC.
recoveryLevel
  • enum:
    • Purgeable
    • Recoverable+Purgeable
    • Recoverable
    • Recoverable+ProtectedSubscription

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
    unixtime

Last updated time in UTC.
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
  • <string, string>

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

The secret value.