Updating the Version Status of a Secret

Function

Update the version status of a secret.

Constraints

The version status of a secret can uniquely identify only one version under the same secret. If you add a status in use to a new version, the status will be automatically removed from the old version. 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. A status can be used for only one version. SYSCURRENT and SYSPREVIOUS are built-in secret statuses.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path 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 that match the regular expression ^[a-zA-Z0-9_-]{1,64}$

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
version_id	Yes	String	Version identifier of a secret.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
stage	Stage object	Secret status

**Table 5** Stage
Parameter	Type	Description
name	String	Status of a secret version. Constraint: The value can contain up to 64 characters.
update_time	Long	Time when a secret version status was updated. The value is a timestamp, that is, the total number of seconds on January 1, 1970 to the current time.
secret_name	String	Secret name.
version_id	String	Version identifier of a secret

Status code: 400

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

Status code: 401

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

Status code: 403

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

Status code: 404

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

Status code: 500

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

Status code: 502

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

Status code: 504

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

Example Requests

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

{
  "version_id" : "version_id"
}

Example Responses

Status code: 200

Request succeeded.

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

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request parameter.
401	A username and password are required.
403	Authentication failed.
404	The requested resource does not exist or is not found.
500	Internal service error.
502	The request failed to be fulfilled because the server received an invalid response from the upstream server.
504	Gateway timed out.

Error Codes

See Error Codes.

Parent Topic: Secret Version Status Management

Previous topic: Secret Version Status Management

Next topic: Querying the Version Status of a Secret

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.