Deleting a secret

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

1. View a description of the CLI delete secret command:

   yc lockbox secret delete --help
   

2. Request a list of secrets:

   yc lockbox secret list --cloud-id <cloud_ID> --folder-name <folder_name>
   

   Result:

   +----------------------+------------------+------------+---------------------+----------------------+--------+
   |          ID          |       NAME       | KMS KEY ID |     CREATED AT      |  CURRENT VERSION ID  | STATUS |
   +----------------------+------------------+------------+---------------------+----------------------+--------+
   | e6q942hj2r5n******** | <secret_1_name>  |            | 2021-11-09 13:07:12 | e2r9pdm39tn2******** | ACTIVE |
   | e4qkyo469mu2******** | <secret_2_name>  |            | 2021-12-09 06:50:37 | e6fpq386othp******** | ACTIVE |
   +----------------------+------------------+------------+---------------------+----------------------+--------+
   

3. To delete a secret, run the command:

   yc lockbox secret delete --id e4qkyo469mu2********
   

   Result:

   id: e4qkyo469mu2********
   folder_id: b1ulgko2th57********
   created_at: "2021-11-08T17:13:48.393Z"
   ...
     status: ACTIVE
     payload_entry_keys:
     - <key>
   

4. Make sure the secret is not in the list:

   yc lockbox secret list --cloud-id <cloud_ID> --folder-name <folder_name>
   

   Result:

   +----------------------+-----------------+------------+---------------------+----------------------+--------+
   |          ID          |      NAME       | KMS KEY ID |     CREATED AT      |  CURRENT VERSION ID  | STATUS |
   +----------------------+-----------------+------------+---------------------+----------------------+--------+
   | e6q942hj2r5n******** | <secret_1_name> |            | 2021-11-09 13:07:12 | e2r9pdm39tn2******** | ACTIVE |
   +----------------------+-----------------+------------+---------------------+----------------------+--------+
   

If you don't have Terraform, install it and configure the Yandex Cloud provider.

1. Open the Terraform configuration file and delete the part with the secret description:

   Sample secret description in the Terraform configuration

   ...
   resource "yandex_lockbox_secret" "my_secret" {
     name                = "My secret"
     description         = "test secret from tf"
     folder_id           = "b1gmitvfx321d3********"
     kms_key_id          = "abjp8q2fjfg0s********"
     deletion_protection = true
     labels              = {
       tf-label    = "tf-label-value",
       empty-label = ""
     }
   }
   ...
   

2. Apply the changes:

   1. In the terminal, change to the folder where you edited the configuration file.

   2. Make sure the configuration file is correct using the command:

      terraform validate
      

      If the configuration is correct, the following message is returned:

      Success! The configuration is valid.
      

   3. Run the command:

      terraform plan
      

      The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.

   4. Apply the configuration changes:

      terraform apply
      

   5. Confirm the changes: type yes in the terminal and press Enter.

You can check the secret deletion using the management console or this CLI command:

yc lockbox secret list

To delete a secret, use the delete REST API method for the Secret resource or the SecretService/Delete gRPC API call.