Oracle Cloud Infrastructure Documentation

Updating Private Endpoint Details

Learn how to update the details of an OCI External Key Management private endpoint.

You can update the display name and tags an External Key Management private endpoint.

    1. Open the navigation menu , select Identity & Security, and then select Private Endpoints.
    2. Find the Private Endpoints you want to update in the list and select the Actions menu (three dots).
    3. Select Edit.
    4. On the Edit Private Endpoint page, update the private endpoint name.
    5. Select Submit.

      After you change an External Key Management private endpoint, you can access the Private Endpoint Details page to see the endpoint in "ACTIVE" state. You can use the actions at the page top to rename, move resource, add tags or delete the endpoint.

  • Use the oci kms ekm ekms-private-endpoint update to update a private endpoint.

    oci kms ekm ekms-private-endpoint update -ekms-private-endpoint-id, -defined-tags

    Example

    --ekms-private-endpoint-id "ocid1.ekmsprivateendpoint.region1.sea.aeezmswpspiaa.abexamplekhf7t52cxoqe6vvb4pwajr", 
--defined-tags { "Tag": {"key": "value"} }, 
--display-name "Example EKMS PE UPDATE", 
--freeform-tags {"key": "value"}

    Avoid entering confidential information.

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

  • Use the UpdateEkmsPrivateEndpoint API to update the private endpoint used for connecting the OCI External Key Management Service (EKMS) to an external key management system.

    Note

    Each region has a unique endpoint for create, update, and list operations for secrets. This endpoint is referred to as the control plane URL or secret management endpoint. Each region also has a unique endpoint for operations related to retrieving secret contents. This endpoint is known as the data plane URL or the secret retrieval endpoint. For regional endpoints, see the API Documentation.

    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.