REST API for Oracle Cloud Infrastructure Compute Classic

Create an IP Address Prefix Set

post

/network/v1/ipaddressprefixset/

An IP address prefix set lists IPv4 addresses in the CIDR address prefix format. After creating an IP address prefix set, you can specify it as a source or destination for permitted traffic while creating a security rule. See Add a Security Rule.

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.

The request body contains details of the IP address prefix set that you want to create.

Root Schema : IpAddressPrefixSet-post-request

Type: object

The request body contains details of the IP address prefix set that you want to create.

Show Source

description(optional): string

Description of the IP address prefix set.
ipAddressPrefixes(optional): array ipAddressPrefixes

List of CIDR IPv4 prefixes assigned in the virtual network.
name: string

The three-part name of the IP address prefix set (/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 prefix set.

{
    "required":[
        "name"
    ],
    "description":"The request body contains details of the IP address prefix set that you want to create. ",
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of the IP address prefix set."
        },
        "ipAddressPrefixes":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"List of CIDR IPv4 prefixes assigned in the virtual network."
        },
        "name":{
            "type":"string",
            "description":"The three-part name of the IP address prefix set (/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 prefix set."
        }
    }
}

Nested Schema : ipAddressPrefixes

Type: array

List of CIDR IPv4 prefixes assigned in the virtual network.

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"List of CIDR IPv4 prefixes assigned in the virtual network."
}

Nested Schema : tags

Type: array

Strings that you can use to tag the IP address prefix set.

Show Source

Array of: string

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

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

Root Schema : IpAddressPrefixSet-response

Type: object

Show Source

description(optional): string

Description of the object.
ipAddressPrefixes(optional): array ipAddressPrefixes

List of CIDR IPv4 prefixes assigned in the virtual network.
name(optional): string

Name of the IP address prefix set.
tags(optional): array tags

Tags associated with the object.
uri(optional): string

Uniform Resource Identifier

{
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of the object."
        },
        "ipAddressPrefixes":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"List of CIDR IPv4 prefixes assigned in the virtual network."
        },
        "name":{
            "type":"string",
            "description":"Name of the IP address prefix set."
        },
        "tags":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"Tags associated with the object."
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier"
        }
    }
}

Nested Schema : ipAddressPrefixes

Type: array

List of CIDR IPv4 prefixes assigned in the virtual network.

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"List of CIDR IPv4 prefixes assigned in the virtual network."
}

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."
}

Examples

cURL Command

The following example shows how to create an IP address prefix set 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 "@ipaddressprefixset.json"
        https://api-z999.compute.us0.oraclecloud.com/network/v1/ipaddressprefixset/

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 ipaddressprefixset.json file.

{
 "name": "/Compute-acme/jack.jones@example.com/ipaddressprefixset1",
 "ipAddressPrefixes": ["192.168.0.0/16"]
}

Example of Response Body

The following example shows the response body in JSON format.

{
 "ipAddressPrefixes": ["192.168.0.0/16"],
 "uri": "https://api-z999.compute.us0.oraclecloud.com/network/v1/ipaddressprefixset/Compute-acme/jack.jones@example.com/ipaddressprefixset1",
 "description": null,
 "tags": [],
 "name": "/Compute-acme/jack.jones@example.com/ipaddressprefixset1"
}