Jump to

• Request
• Response
• Examples

Update an IP Address Reservation Used in IP Networks

put

/network/v1/ipreservation/{name}

Updates the specified IP address reservation.

Required Role: To complete this task, you must have the Compute_Operations role. If this role isn't assigned to you or you're not sure, then ask your system administrator to ensure that the role is assigned to you in Oracle Cloud My Services. See Modifying User Roles in Managing and Monitoring Oracle Cloud.

Request

Supported Media Types

• application/oracle-compute-v3+json

Path Parameters

• name: string
  The three-part name of the object (/Compute-identity_domain/user/object).

Header Parameters

• Cookie: string
  The Cookie: header must be included with every request to the service. It must be set to the value of the set-cookie header in the response received to the POST /authenticate/ call.

Body ()

The request body contains details of the IP address reservation that you want to update.

Root Schema : IpAddressReservation-put-request

Type: object

The request body contains details of the IP address reservation that you want to update.

Show Source

• description(optional): string
  Description of the IP address reservation.
• ipAddressPool(optional): string
  The IP address pool from which you want to reserve an IP address. Specify one of the following values:

  * /oracle/public/public-ippool: A pool of public IP addresses. An IP address from this pool is accessible over the public Internet.

  * /oracle/public/cloud-ippool: A pool of cloud IP addresses. An IP address from this pool is accessible to other IP networks in the Oracle cloud. You can use these IP addresses to communicate with other Oracle services.

• name: string
  The three-part name of the IP address reservation(/Compute-identity_domain/user/object).

  Object names can contain only alphanumeric characters, hyphens, underscores, and periods. Object names are case-sensitive. When you specify the object name, ensure that an object of the same type and with the same name doesn't already exist. If such an object already exists, another object of the same type and with the same name won't be created and the existing object won't be updated.

• tags(optional): array tags
  Strings that you can use to tag the IP address reservation.

{
    "required":[
        "name"
    ],
    "description":"The request body contains details of the IP address reservation that you want to update. ",
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of the IP address reservation."
        },
        "ipAddressPool":{
            "type":"string",
            "description":"The IP address pool from which you want to reserve an IP address. Specify one of the following values:<p>* <code>/oracle/public/public-ippool</code>: A pool of public IP addresses. An IP address from this pool is accessible over the public Internet.<p>* <code>/oracle/public/cloud-ippool</code>: A pool of cloud IP addresses. An IP address from this pool is accessible to other IP networks in the Oracle cloud. You can use these IP addresses to communicate with other Oracle services."
        },
        "name":{
            "type":"string",
            "description":"The three-part name of the IP address reservation(/Compute-identity_domain/user/object).<p>Object names can contain only alphanumeric characters, hyphens, underscores, and periods. Object names are case-sensitive. When you specify the object name, ensure that an object of the same type and with the same name doesn't already exist. If such an object already exists, another object of the same type and with the same name won't be created and the existing object won't be updated."
        },
        "tags":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"Strings that you can use to tag the IP address reservation."
        }
    }
}

Nested Schema : tags

Type: array

Strings that you can use to tag the IP address reservation.

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"Strings that you can use to tag the IP address reservation."
}

Back to Top

Response

Supported Media Types

• application/oracle-compute-v3+json

200 Response

OK. See Status Codes for information about other possible HTTP status codes.

Headers

• set-cookie: string
  The cookie value is returned if the session is extended

Body ()

Root Schema : IpAddressReservation-response

Type: object

Show Source

• description(optional): string
  Description of the object.
• ipAddress(optional): string
  Reserved NAT IPv4 address from the IP address pool.
• ipAddressPool(optional): string
  Name of the IP address pool to reserve the NAT IP from.
• name(optional): string
  Name of the IP address reservation.
• tags(optional): array tags
  Tags associated with the object.
• uri(optional): string
  Uniform Resource Identifier

{
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of the object."
        },
        "ipAddress":{
            "type":"string",
            "description":"Reserved NAT IPv4 address from the IP address pool."
        },
        "ipAddressPool":{
            "type":"string",
            "description":"Name of the IP address pool to reserve the NAT IP from."
        },
        "name":{
            "type":"string",
            "description":"Name of the IP address reservation."
        },
        "tags":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"Tags associated with the object."
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier"
        }
    }
}

Nested Schema : tags

Type: array

Tags associated with the object.

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"Tags associated with the object."
}

Back to Top

Examples

cURL Command

The following example shows how to update an IP reservation /Compute-acme/[e-mail]/ipreservation1, which is used in IP networks by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL.

Enter the command on a single line. Line breaks are used in this example for readability.

curl -i -X PUT
     -H "Cookie: $COMPUTE_COOKIE"
     -H "Content-Type: application/oracle-compute-v3+json"
     -H "Accept: application/oracle-compute-v3+json"
     -d "@requestbody.json"
        https://api-z999.compute.us0.oraclecloud.com/network/v1/ipreservation/Compute-acme/[e-mail]/ipreservation1

• COMPUTE_COOKIE is the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authentication.

• api-z999.compute.us0.oraclecloud.com is an example REST endpoint URL. Change this value to the REST endpoint URL of your Compute Classic site. For information about finding out REST endpoint URL for your site, see Send Requests.

• acme and [e-mail] are example values. Replace acme with the identity domain ID of your Compute Classic account, and [e-mail] with your user name.

Example of Request Body

The following shows an example of the request body content in the requestbody.json file to update the description of an IP reservation used in IP networks.

{
  "name": "/Compute-acme/[e-mail]/ipreservation1",
  "ipAddressPool": "/oracle/public/public-ippool",
  "description": "updated description for IP reservation"
}

Example of Response Body

The following example shows the response body in JSON format when you update an IP reservation used in IP networks.

{
  "name": "/Compute-acme/[e-mail]/ipreservation1",
  "uri": "https://api-z999.compute.us0.oraclecloud.com/network/v1/ipreservation/Compute-acme/[e-mail]/ipreservation1",
  "description": "updated description for IP reservation",
  "tags": [],
  "ipAddress": "10.252.152.90",
  "ipAddressPool": "/oracle/public/public-ippool"
}

Back to Top