1. REST API for Oracle Private Cloud Appliance Compute Enclave
  2. Tasks
  3. Networking
  4. Public IPs

Update a Public IP

put

/20160918/publicIps/{public_ip_id}

Update the specified public IP. Use this operation to:
  • Assign a reserved public IP in your pool to a private IP.
  • Move a reserved public IP to a different private IP.
  • Unassign a reserved public IP from a private IP. This operation returns the reserved public IP to your pool of reserved public IPs.
  • Change the display name or tags for a public IP.

    Assigning, moving, and unassigning a reserved public IP are asynchronous operations. Poll the public IP resource's lifecycleState to determine whether the operation succeeded.

    Note: When you move a reserved public IP, the target private IP must not already have a public IP with lifecycleState of ASSIGNING or ASSIGNED. If it does, an error is returned.

    Note: The initial unassignment from the original private IP always succeeds, but the assignment to the target private IP is asynchronous and could fail silently. For example, the assignment could fail silently if the target private IP is deleted or has a different public IP assigned to it in the interim. If that occurs, the public IP remains unassigned and its lifecycleState switches to AVAILABLE; it is not reassigned to its original private IP. Poll the public IP resource's lifecycleState to determine whether the move succeeded.

    To assign an ephemeral public IP to a primary private IP, use CreatePublicIp. You cannot move an ephemeral public IP to a different private IP.

    To unassign an ephemeral public IP from its private IP, use DeletePublicIp, which unassigns and deletes the ephemeral public IP.

    Note: If a public IP is assigned to a secondary private IP, and you move that secondary private IP to another VNIC, the public IP moves with it.

    If you try to move a reserved public IP to a VNIC or instance that already has its maximum allowed number of public IPs, an error is returned.

    • Request

    Supported Media Types
    Path Parameters
    Header Parameters
    • For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
    Body ()
    Public IP details.
    Root Schema : UpdatePublicIpDetails
    Type: object
    Show Source
    • definedTags
      Additional Properties Allowed: additionalProperties
      Defined tags for this resource. Each key is predefined and scoped to a namespace.
    • Minimum Length: 1
      Maximum Length: 255
      A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
    • freeformTags
      Additional Properties Allowed: additionalProperties
      Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
    • Minimum Length: 0
      Maximum Length: 255
      The OCID of the private IP to assign the public IP to. If the public IP is already assigned to a different private IP, it will be unassigned and then reassigned to the specified private IP. If you set this field to an empty string, the public IP will be unassigned from the private IP it is currently assigned to.
    Nested Schema : definedTags
    Type: object
    Additional Properties Allowed
    Show Source
    Defined tags for this resource. Each key is predefined and scoped to a namespace.
    Nested Schema : freeformTags
    Type: object
    Additional Properties Allowed
    Show Source
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
    Nested Schema : additionalProperties
    Type: object
    Additional Properties Allowed
    Show Source
    Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`
    Nested Schema : additionalProperties
    Type: object
    The value of the tag. Only the String type is supported.
    Back to Top

    Response

    Supported Media Types

    200 Response

    The public IP was updated.
    Headers
    • For optimistic concurrency control. See `if-match`.
    • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
    Body ()
    Root Schema : PublicIp
    Type: object
    A public IP is a conceptual term that refers to a public IP address and related properties. The publicIp object is the API representation of a public IP. There are two types of public IPs: 1. Ephemeral 2. Reserved
    Show Source
    • Minimum Length: 1
      Maximum Length: 255
      The OCID of the entity the public IP is assigned to, or in the process of being assigned to.
    • Allowed Values: [ "PRIVATE_IP", "NAT_GATEWAY" ]
      The type of entity the public IP is assigned to, or in the process of being assigned to.
    • Minimum Length: 1
      Maximum Length: 255
      The public IP's availability domain. This property is set only for ephemeral public IPs that are assigned to a private IP (when the scope of the public IP is set to AVAILABILITY_DOMAIN). The value is the availability domain of the assigned private IP. Example: AD-1
    • Minimum Length: 1
      Maximum Length: 255
      The OCID of the compartment containing the public IP. For an ephemeral public IP, this is the compartment of its assigned entity (which can be a private IP or a regional entity such as a NAT gateway). For a reserved public IP that is currently assigned, its compartment can be different from the assigned private IP's.
    • definedTags
      Additional Properties Allowed: additionalProperties
      Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
    • Minimum Length: 1
      Maximum Length: 255
      A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    • freeformTags
      Additional Properties Allowed: additionalProperties
      Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
    • Minimum Length: 1
      Maximum Length: 255
      The public IP's OCID.
    • The public IP address of the publicIp object. Example: 203.0.113.2
    • Allowed Values: [ "PROVISIONING", "AVAILABLE", "ASSIGNING", "ASSIGNED", "UNASSIGNING", "UNASSIGNED", "TERMINATING", "TERMINATED" ]
      The public IP's current state.
    • Allowed Values: [ "EPHEMERAL", "RESERVED" ]
      Defines when the public IP is deleted and released back to the public IP pool. EPHEMERAL: The lifetime is tied to the lifetime of its assigned entity. An ephemeral public IP must always be assigned to an entity. If the assigned entity is a private IP, the ephemeral public IP is automatically deleted when the private IP is deleted, when the VNIC is terminated, or when the instance is terminated. If the assigned entity is a NatGateway, the ephemeral public IP is automatically deleted when the NAT gateway is terminated. RESERVED: You control the public IP's lifetime. You can delete a reserved public IP whenever you like. It does not need to be assigned to a private IP at all times.
    • Minimum Length: 1
      Maximum Length: 255
      Deprecated. Use assignedEntityId instead. The OCID of the private IP that the public IP is currently assigned to, or in the process of being assigned to. Note: This is null if the public IP is not assigned to a private IP, or is in the process of being assigned to one.
    • Minimum Length: 1
      Maximum Length: 255
      The OCID of the pool object created in the current tenancy.
    • Allowed Values: [ "REGION", "AVAILABILITY_DOMAIN" ]
      Whether the public IP is regional or specific to a particular availability domain. REGION - The public IP exists within a region and is assigned to a regional entity (such as a NatGateway), or can be assigned to a private IP in any availability domain in the region. Reserved public IPs and ephemeral public IPs assigned to a regional entity have scope = REGION. AVAILABILITY_DOMAIN - The public IP exists within the availability domain of the entity it's assigned to, which is specified by the availabilityDomain property of the public IP object. Ephemeral public IPs that are assigned to private IPs have scope = AVAILABILITY_DOMAIN.
    • The date and time the public IP was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
    Nested Schema : definedTags
    Type: object
    Additional Properties Allowed
    Show Source
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
    Nested Schema : freeformTags
    Type: object
    Additional Properties Allowed
    Show Source
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
    Nested Schema : additionalProperties
    Type: object
    Additional Properties Allowed
    Show Source
    Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`
    Nested Schema : additionalProperties
    Type: object
    The value of the tag. Only the String type is supported.

    400 Response

    Bad Request
    Headers
    • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source
    • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
    • A human-readable error string.

    401 Response

    Unauthorized
    Headers
    • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source
    • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
    • A human-readable error string.

    404 Response

    Not Found
    Headers
    • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source
    • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
    • A human-readable error string.

    412 Response

    Precondition Failed
    Headers
    • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source
    • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
    • A human-readable error string.

    500 Response

    Internal Server Error
    Headers
    • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source
    • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
    • A human-readable error string.

    Default Response

    An error has occurred.
    Headers
    • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source
    • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
    • A human-readable error string.
    Back to Top