Oracle Cloud Infrastructure Documentation

Editing an Object Storage Private Endpoint

Update an Object Storage private endpoint's configuration.

You can update the following settings for a private endpoint:

  • Access targets
  • Tagging
  • Security attributes

You can't update the following:

  • The compartment where the private endpoint resides.
  • Private endpoint name
  • DNS prefix
  • Network security group
    1. On the Private endpoints list page, select the Object Storage private endpoint that you want to work with. If you need help finding the list page or the Object Storage private endpoint, see Listing Private Endpoints in Object Storage.
    2. From the Actions menu for the private endpoint, select Edit endpoint.
      The Edit private endpoint panel opens.
    3. Update the settings as needed. Avoid entering confidential information. For descriptions of the settings, see Creating a Private Endpoint.
    4. To add only security attributes, select the Security tab and then select Add security attributes.

      You can add up to three security attributes to control access to this private endpoint. Select Add security attribute, and then enter the following information:

      • Namespace: Select a security attribute namespace from the list. A security attribute namespace is a container for a set of security attributes in Zero Trust Packet Routing (ZPR).

        This list contains those security attribute namespaces already configured. See Creating a Security Attribute Namespace for more information.

      • Key: Select a key from the list. The key is the name for a specific security attribute.
      • Value: Enter a value or select a value for the corresponding key from the list. This is the value for a specific security attribute.

      To understand the permissions required to apply, update, or remove a security attribute for a resource, see Security Attributes.

      See also Adding Security Attributes to a Private Endpoint.

    5. Select Update.

  • Use the oci os private-endpoint update command and required parameters to edit a private endpoint in Object Storage:

    oci os private-endpoint update --pe-name private_endpoint_name --name private_endpoint_name --access-targets access_targets [OPTIONS]

    where access_targets lists one or more access targets being updated to the new settings using the following syntax:

    '[{"namespace":"namespace", "compartmentId":"compartment_ocid", "bucket":"bucket"}]'

    For example:

    oci os private-endpoint update --pe-name pe1 --name pe1 --access-targets '[{"namespace":"MyNamespace", "compartmentId":"ocid1.tenancy.oc1..exampleuniqueID", "bucket":"*"}]'
{
  "opc-work-request-id": "f52e20e6-2c21-4544-be98-c7f9b590c9db"
}

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

  • Run the following API operation:

    POST n/object_storage_namespace/pe/peName

    These are the available payload properties:

    • name: The name of the private endpoint.
    • accessTargets: A list of targets that can be accessed by the private endpoint.
    • freeformTags (optional): Free-form tags for this resource.
    • definedTags (optional): Defined tags for this resource.
    • namespace The Object Storage namespace associated with the private endpoint.
    • securityAttributes (optional): Security attributes for this resource. Each key is predefined and scoped to a namespace.

      Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}

    See also UpdatePrivateEndpoint.