Oracle Cloud Infrastructure Documentation

Backing up a Vault

Learn how to back up an OCI vault and its keys.

    1. Open the navigation menu , select Identity & Security, and then select Vault.
    2. Under List Scope, in the Compartment list, select the name of the compartment that contains the vault that you want to back up.

    3. From the list of vaults in the compartment, select the name of the vault.

    4. On the Vault Details page, select Back Up Vault.
    5. Select a source: export a backup to either an Existing Object Storage Bucket (recommended) or a pre-authenticated Object Storage URL for an object that you can write to.
    6. Do one of the following, depending on what you chose in the previous step:
      • Select a bucket from the dropdown menu. If needed, you can change the compartment to find a bucket in a different compartment. Then, specify the Backup Name. Avoid entering confidential information.
      • Select Object Storage URL, and then provide a pre-authenticated URL for an object.
    7. Optionally, to back up only the vault without any keys, select the Back up vault metadata only checkbox.
    8. When you are finished, select Back Up Vault. (Note the compartment so that you can restore this resource to the right compartment later.)

  • Use the oci kms management vault backup command and required parameters to restore a key:

    oci kms management vault backup --bucket-name <bucket_name> --from-json <json_input>

    See Advanced JSON Options for information on using JSON input with this command.

    For a complete list of parameters and values for CLI commands, see the CLI Command Reference.

  • Use the BackupVault API with the Management Endpoint to back up a vault.

    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.