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

Deleting a Secret Immediately

Function

This API is used to immediately delete a specified secret. The deleted secret cannot be restored.

Constraints

Secrets deleted via this API cannot be restored.

Debugging

You can debug this API in API Explorer.

URI

DELETE /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).

Response Parameters

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Request

None

Example Response

None

Status Code

Status Code

Description

200

The request has succeeded.

400

Request error.

Error Code

For details, see Error Code.

Parent topic: Lifecycle Management