Update a Private Gateway

put

/network/v1/privategateway/{name}

This endpoint is not available on Oracle Cloud Machine.

You can update the IP networks that are associated with a private gateway, the description, and tags.

If a FastConnect Classic private peering has already been set up using the private gateway that you are updating, traffic immediately starts flowing to the instances on updated IP networks over the FastConnect Classic private peering.

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
Path Parameters
  • The three-part name of the object (/Compute-identity_domain/user/object).
Header Parameters
Body ()
The request body contains details of the private gateway that you want to update.
Root Schema : PrivateGateway-put-request
Type: object
The request body contains details of the private gateway that you want to update.
Show Source
Nested Schema : ipNetworks
Type: array
List of IP networks that you want associate with the private gateway. If you are updating a private gateway that is being used in FastConnect Classic private peering, then traffic starts flowing immediately to instances on the updated IP networks from your premises.
Show Source
Nested Schema : tags
Type: array
Tags associated with the object.
Show Source

Response

Supported Media Types

200 Response

OK. See Status Codes for information about other possible HTTP status codes.
Headers
Body ()
Root Schema : PrivateGateway-response
Type: object
Show Source
Nested Schema : ipNetworks
Type: array
List of IP networks that is associated with the private gateway. When you set up FastConnect Classic private peering, you can directly access the instances on these IP networks from your premises without using NAT or IPSec VPN.
Show Source
Nested Schema : tags
Type: array
Tags associated with the object.
Show Source

Examples

cURL Command

The following example shows how to update a private gateway, /Compute-acme/jack.jones@example.com/privategateway1, 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 "@privategateway.json"
        https://api-z999.compute.us0.oraclecloud.com/network/v1/privategateway/Compute-acme/jack.jones@example.com/privategateway1
  • 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 jack.jones@example.com are example values. Replace acme with the identity domain ID of your Compute Classic account, and jack.jones@example.com with your user name.

  • After creating the request body JSON file, you should validate it. You can do this by using a third-party tool, such as JSONLint, or any other validation tool of your choice. If your JSON format isn???t valid, then an error message is displayed when you pass the request body.

Example of Request Body

The following shows an example of the request body content in the privategateway.json file to update the description and IP networks of a private gateway.

{
 "name": "/Compute-acme/jack.jones@example.com/privategateway1",
 "ipNetworks": ["/Compute-acme/jack.jones@example.com/ipnet1"],
 "description": "updated description"
}

Example of Response Body

The following example shows the response body in JSON format when you update a private gateway.

{
  "name": "/Compute-acme/jack.jones@example.com/privategateway1",
  "uri": "https://api-z999.compute.us0.oraclecloud.com:443/network/v1/privategateway/Compute-acme/jack.jones@example.com/privategateway1",
  "description": "updated description",
  "tags": [],
  "ipNetworks": [
    "/Compute-acme/jack.jones@example.com/ipnet1"
  ]
}