Jump to

• Request
• Response
• Examples

Create an IP Network

post

/network/v1/ipnetwork/

Creates an IP network. An IP network allows you to define an IP subnet in your account. With an IP network you can isolate instances by creating separate IP networks and adding instances to specific networks. Traffic can flow between instances within the same IP network, but by default each network is isolated from other networks and from the public Internet.

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

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 network that you want to create.

Root Schema : IpNetwork-post-request

Type: object

The request body contains details of the IP network that you want to create.

Show Source

• description(optional): string
  Description of the object.
• ipAddressPrefix: string
  Specify the size of the IP subnet. It is a range of IPv4 addresses assigned in the virtual network, in CIDR address prefix format.

  While specifying the IP address prefix take care of the following points:

  * These IP addresses aren't part of the common pool of Oracle-provided IP addresses used by the shared network.

  * There's no conflict with the range of IP addresses used in another IP network, the IP addresses used your on-premises network, or with the range of private IP addresses used in the shared network. If IP networks with overlapping IP subnets are linked to an IP exchange, packets going to and from those IP networks are dropped.

  * The upper limit of the CIDR block size for an IP network is /16.

  Note: The first IP address of any IP network is reserved for the default gateway, the DHCP server, and the DNS server of that IP network.

• ipNetworkExchange(optional): string
  Specify the IP network exchange to which the IP network belongs. You can add an IP network to only one IP network exchange, but an IP network exchange can include multiple IP networks. An IP network exchange enables access between IP networks that have non-overlapping addresses, so that instances on these networks can exchange packets with each other without NAT.
• name: string
  The three-part name (/Compute-identity_domain/user/object) of the IP network.

  Object names can contain only alphanumeric, underscore (_), dash (-), and period (.) characters. Object names are case-sensitive.

• tags(optional): array tags
  Tags associated with the object.

{
    "required":[
        "ipAddressPrefix",
        "name"
    ],
    "description":"The request body contains details of the IP network that you want to create. ",
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of the object."
        },
        "ipAddressPrefix":{
            "type":"string",
            "description":"Specify the size of the IP subnet. It is a range of IPv4 addresses assigned in the virtual network, in CIDR address prefix format.<p>While specifying the IP address prefix take care of the following points:<p>* These IP addresses aren't part of the common pool of Oracle-provided IP addresses used by the shared network.<p>* There's no conflict with the range of IP addresses used in another IP network, the IP addresses used your on-premises network, or with the range of private IP addresses used in the shared network. If IP networks with overlapping IP subnets are linked to an IP exchange, packets going to and from those IP networks are dropped.<p>* The upper limit of the CIDR block size for an IP network is /16.<p>Note: The first IP address of any IP network is reserved for the default gateway, the DHCP server, and the DNS server of that IP network. "
        },
        "ipNetworkExchange":{
            "type":"string",
            "description":"Specify the IP network exchange to which the IP network belongs. You can add an IP network to only one IP network exchange, but an IP network exchange can include multiple IP networks. An IP network exchange enables access between IP networks that have non-overlapping addresses, so that instances on these networks can exchange packets with each other without NAT. "
        },
        "name":{
            "type":"string",
            "description":"The three-part name (<code>/Compute-<em>identity_domain</em>/<em>user</em>/<em>object</em></code>) of the IP network. <p>Object names can contain only alphanumeric, underscore (_), dash (-), and period (.) characters. Object names are case-sensitive."
        },
        "tags":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"Tags associated with the object."
        }
    }
}

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

Response

Supported Media Types

• application/oracle-compute-v3+json

201 Response

Created. 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 : IpNetwork-response

Type: object

Show Source

• description(optional): string
  Description of the object.
• ipAddressPrefix(optional): string
  CIDR IPv4 prefix associated with this IP network.
• ipNetworkExchange(optional): string
  Name of the IP network exchange associated with this IP network.
• name(optional): string
  The three-part name (/Compute-identity_domain/user/object) of the IP network.
• tags(optional): array tags
  Tags associated with the object.
• uri(optional): string
  Uniform Resource Identifier

{
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of the object."
        },
        "ipAddressPrefix":{
            "type":"string",
            "description":"CIDR IPv4 prefix associated with this IP network."
        },
        "ipNetworkExchange":{
            "type":"string",
            "description":"Name of the IP network exchange associated with this IP network."
        },
        "name":{
            "type":"string",
            "description":"The three-part name (<code>/Compute-<em>identity_domain</em>/<em>user</em>/<em>object</em></code>) of the IP network."
        },
        "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 create an IP network by submitting a POST 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 POST
     -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/ipnetwork/

• 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.

Example of Request Body

The following shows an example of the request body content in the requestbody.json file.

{
 "name": "/Compute-acme/[e-mail]/ipnet1",
 "ipAddressPrefix": "192.168.0.0/24"
}

Example of Response Body

The following example shows the response body in JSON format.

{
  "name": "/Compute-acme/[e-mail]/ipnet1",
  "uri": "https://api-z999.compute.us0.oraclecloud.com:443/network/v1/ipnetwork/Compute-acme/[e-mail]/ipnet1",
  "description": null,
  "tags": null,
  "ipAddressPrefix": "192.168.0.0/24",
  "ipNetworkExchange": null
}

Back to Top