Oracle Cloud Infrastructure Documentation

Canceling the Scheduled Deletion of a Key Reference

Learn how to cancel a scheduled key reference deletion in OCI External Key Management.

You can cancel the scheduled deletion of a key reference while the key reference is in the 7-day waiting period that starts when the deletion is requested as described in Deleting Key References. After the waiting period is over, External Key Management deletes the key reference, and the key reference can't be recovered. However, the encryption key stored in the external key management system isn't deleted by OCI.

    1. Open the navigation menu , select Identity & Security, and then select External Key Management.
    2. On the External key Management home page, select a vault from the list.
    3. On the Vault Details page, select a key reference.
    4. On the Key Reference Details page, select Cancel Deletion.

      When you cancel a deletion, the key reference is set to the "Active" state. You can only cancel a scheduled deletion during the 7 day waiting period that starts when the deletion is scheduled.

  • Open a command prompt and run oci kms management key cancel-deletion to cancel a key reference deletion.

    oci kms management key cancel-deletion -external-key-reference-id <target_key_id> --endpoint <control_plane_url>

    For a complete list of flags and variable options for Vault CLI commands, see Command Line Reference.

  • Use the CancelKeyDeletion API with the Management Endpoint to cancel deletion of a key reference.

    Note

    The Management Endpoint is used for management operations including Create, Update, List, Get, and Delete. The Management Endpoint is also called the control plane URL or the KMSMANAGMENT endpoint.

    The Cryptographic Endpoint is used for cryptographic operations including Encrypt, Decrypt, Generate Data Encryption Key, Sign, and Verify. The Cryptographic Endpoint is also called the data plane URL or the KMSCRYPTO endpoint.

    You can find the management and cryptographic endpoints in a vault's details metadata. See Getting a Vault's Details for instructions.

    For regional endpoints for the Key Management, Secret Management, and Secret Retrieval APIs, see API Reference and Endpoints.

    For information about using the API and signing requests, see REST API documentation and Security Credentials. For information about SDKs, see SDKs and the CLI.