Help Center> Data Encryption Workshop> API Reference> APIs> Secret Management APIs> Secret Version Status Management> Querying the Status of a Secret Version
View PDF

Querying the Status of a Secret Version

Function

This API is used to query the status of a specified secret version.

Debugging

You can debug this API in API Explorer.

URI

GET /v1/{project_id}/secrets/{secret_name}/stages/{stage_name}

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

secret_name

Yes

String

Secret name

stage_name

Yes

String

Name of a secret version status.

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

stage

Stage object

Secret status
Table 4 Stage

Parameter

Type

Description

name

String

Name of a secret version status.

Constraint: 1 to 64 characters long

update_time

Long

Secret version update timestamp. The timestamp indicates the total seconds past the start of the epoch date (January 1, 1970).

secret_name

String

Secret name

version_id

String

Secret version ID

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Request

None

Example Response

Status code: 200

The request has succeeded.

{
  "stage" : {
    "name" : "name",
    "version_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "update_time" : 1581507580000,
    "secret_name" : "secret-name-demo"
  }
}

Status Code

Status Code

Description

200

The request has succeeded.

400

Request error.

Error Code

For details, see Error Code.