POST SecretStore/Retrieve

Retrieves the vault entry only when there is no Credential object associated with the Secret Store. Prior to making this API call, use POST SecretStore/OwnerLookup . If the secret is protected with a Credential object, call POST Credentials/Retrieve instead.

Requirements

  • Permissions: The caller must have Master Admin permission.
  • Token scope:  Restricted:Manage

Headers

  • Content type: Content-Type:application/json.

  • Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

Input parameters

Name

Description

VaultID

The integer that uniquely identifies the vault entry that holds the data.

Returns

Upon success, SecretStore/Retrieve returns a HTTP 200 message. If successful, the event information appears in the Trust Protection Platform log.

Response description

Name

Description

Base64Data

The data in Base64 format.

Result

A number indicating the status:

VaultType

The vault type of the item. See SecretStore Vault Type.

Example

Request

POST https://tpp.venafi.example/vedsdk/SecretStore/Retrieve
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "VaultID":376
}

Response

HTTP/1.1 200 OK
{
   "Base64Data":"cGFzc3cwcmQ= ...",
   "Result":0,
   "VaultType":32
}