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

Updating the Version Status of a Secret

Function

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

Constraints

  • 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. Versions without any statuses are regarded as deprecated versions and can be automatically deleted by CSMS.

  • A secret can have up to 12 version statuses. A status can be used for only one version. SYSCURRENT and SYSPREVIOUS are the preconfigured secret statuses of a service.

Debugging

You can debug this API in API Explorer.

URI

PUT /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).
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

version_id

Yes

String

Secret version ID

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

stage

Stage object

Secret status
Table 5 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 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Request

{
  "version_id" : "version_id"
}

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.