Help Center> Data Encryption Workshop> API Reference> APIs> Secret Management APIs> Lifecycle Management> Updating a Secret
View PDF

Updating a Secret

Function

This API is used to update the metadata of a specified secret.

Constraints

This API can be used to modify only the secret metadata, not the secret value.

Debugging

You can debug this API in API Explorer.

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

secret_name

Yes

String

Secret name

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 parameters

Parameter

Mandatory

Type

Description

kms_key_id

No

String

ID of the KMS CMK used to encrypt secret values. The CMK of a secret can be updated. Secret versions after the update use the new CMK for encryption. Secret versions before the update use the old CMK for decryption.

description

No

String

Description of a secret

Constraints: The value contains 2048 bytes.

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

secret

Secret object

Secret
Table 5 Secret parameters

Parameter

Type

Description

id

String

Secret ID

name

String

Secret name

state

String

Secret status. Its value can be:

ENABLED

DISABLED

PENDING_DELETE

FROZEN

kms_key_id

String

ID of the KMS CMK used to encrypt secret values

description

String

Description of a secret

create_time

Long

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

update_time

Long

Time when a secret was last updated. The timestamp indicates the total seconds past the start of the epoch date (January 1, 1970).

scheduled_delete_time

Long

Time when a secret will be deleted as scheduled. The timestamp indicates the total seconds past the start of the epoch date (January 1, 1970).

If a secret is not in Pending deletion state, the value of this parameter is null.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Request

{
  "name" : "test",
  "description" : "update description"
}

Example Response

Status code: 200

The request has succeeded.

{
  "secret" : {
    "id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "name" : "test",
    "state" : "ENABLED",
    "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b",
    "description" : "description",
    "create_time" : 1581507580000,
    "update_time" : 1581507580000,
    "scheduled_delete_time" : 1581507580000
  }
}

Status Code

Status Code

Description

200

The request has succeeded.

400

Request error.

Error Code

For details, see Error Code.

Parent topic: Lifecycle Management