Updated on 2026-09-21 GMT+08:00

Creating a Secret Version Status

This API is used to create a secret version status.

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. A version without any version status identifier is considered deprecated and can be automatically deleted by CSMS.
A secret can have up to 12 version statuses. Each status can be used for only one version. SYSCURRENT and SYSPREVIOUS are built-in secret statuses.

For details, see Calling APIs.

POST /v1/{project_id}/secrets/{secret_name}/stages

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range The value returned by the IAM API is used, which contains 32 characters. Default Value N/A
secret_name	Yes	String	Definition Secret name. Constraints N/A Range The value must match the regular expression ^[a-zA-Z0-9_-]{1,64}$. Default Value N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. This parameter is optional if AK/SK authentication is used. Constraints N/A Range Obtain the value by calling the IAM API for obtaining the user token. Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Name of a secret version status. Constraints N/A Range The value must match the regular expression ^[a-zA-Z0-9_-]{1,64}$. Default Value N/A
version_id	Yes	String	Definition Secret version ID Constraints A secret can have up to 20 versions. Range The value must match the regular expression ^v[0-9]{0,63}. Default Value N/A

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
stage	Stage object	Definition Secret version status. Range N/A

**Table 5** Stage
Parameter	Type	Description
name	String	Definition Name of a secret version status Range N/A
update_time	Long	Definition Timestamp when a secret version status was last updated, that is, total number of seconds since January 1, 1970. Range N/A
secret_name	String	Definition Secret name Range N/A
version_id	String	Definition Secret version ID Range N/A

Update the version status of a secret. The version is version_id.

{
  "version_id" : "v1",
  "name" : "test"
}

Status code: 200

Request succeeded.

{
  "stage" : {
    "name" : "name",
    "version_id" : "v1",
    "update_time" : 1581507580000,
    "secret_name" : "secret-name-demo"
  }
}

Status Code	Description
200	Request succeeded.