Updating the Version Status of a Secret

Function

This API is used to 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.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

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.

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 that is used for obtaining a user token. The value of X-Subject-Token in the response header is the user 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 timestamp indicates the total seconds past the start of the epoch date (January 1, 1970).
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 code
error_msg	String	Error message

Status code: 401

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

Status code: 403

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

Status code: 404

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

Status code: 500

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

Status code: 502

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

Status code: 504

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

Example Requests

{
  "version_id" : "version_id"
}

Example Responses

Status code: 200

Request succeeded.

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

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request parameters.
401	You must enter a username and password to access the requested page.
403	Authentication failed.
404	The requested resource does not exist or is not found.
500	Internal service error.
502	Failed to complete the request. The server received an invalid response.
504	Gateway timeout.