Querying the Secret Version and Value

Function

Query a specified secret version and the plaintext secret value in the version. Only enabled secrets can be queried. The value of the latest secret version can be obtained via /v1/{project_id}/secrets/{secret_name}/versions/latest. (Set the {version_id} in the URL of the current API to latest).

URI

GET /v1/{project_id}/secrets/{secret_name}/versions/{version_id}

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
secret_name	Yes	String	Secret name
version_id	Yes	String	Secret version ID

Request Parameter

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

**Table 3** Response body parameter
Parameter	Type	Description
version	Version object	Secret version

**Table 4** Version
Parameter	Type	Description
version_metadata	VersionMetadata object	Status of a secret version
secret_binary	String	Plaintext of a binary secret in Base64 format. CSMS encrypts it and stores it in the initial version of the secret. Type: binary data object in Base64 format
secret_string	String	Plaintext of a binary secret in text format. CSMS encrypts it and stores it in the initial version of the secret.

**Table 5** VersionMetadata
Parameter	Type	Description
id	String	ID of a secret version. A secret cannot have duplicate version IDs.
create_time	Long	Secret version creation time. The timestamp indicates the total seconds past the start of the epoch date (January 1, 1970).
kms_key_id	String	ID of the KMS CMK used to encrypt secret values.
secret_name	String	Secret name
version_stages	Array of strings	Status of a secret version. A status tag can be used for only one version of each secret. For example, if you add the status tag used by version A to version B, the tag will be moved from version A to version B. If the version_stage parameter is not specified, the status of the latest version will be SYSCURRENT by default.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error description

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error description

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error description

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error description

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error description

Status code: 502

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error description

Status code: 504

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error description

Example Request

None

Example Response

Status code: 200

Request succeeded.

{
  "version" : {
    "version_metadata" : {
      "id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
      "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b",
      "create_time" : 1581507580000,
      "secret_name" : "secret-name-demo",
      "version_stages" : [ "pending", "used" ]
    },
    "secret_binary" : "secret_binary",
    "secret_string" : "secret_string"
  }
}

Status Code

Status Code	Description
200	Request succeeded.
400	Invalid request parameters.
401	Username and password are required for the requested page.
403	Authentication failed.
404	The requested resource does not exist.
500	Internal service error.
502	Failed to complete the request. The server receives an invalid response from the upstream server.
504	Gateway timed out.