Help Center> Data Encryption Workshop> API Reference> APIs> Secret Management APIs> Lifecycle Management> Creating a Scheduled Secret Deletion Task
View PDF

Creating a Scheduled Secret Deletion Task

Function

This API is used to create a scheduled task to delete a secret in 7 to 30 days.

Constraints

If a secret is in Pending deletion state, its metadata cannot be updated and its value cannot be viewed.

Debugging

You can debug this API in API Explorer.

URI

POST /v1/{project_id}/secrets/{secret_name}/scheduled-deleted-tasks/create

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 parameter

Parameter

Mandatory

Type

Description

recovery_window_in_days

Yes

Integer

Create a scheduled secret deletion task and specify the waiting period before deletion.

Constraints: The waiting period can be 7 to 30 days.

Default value: 30

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

secret

Secret object

Secret
Table 5 Secret

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

{
  "recovery_window_in_days" : 15
}

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

Error response

Error Code

For details, see Error Code.

Parent topic: Lifecycle Management