REST API for Oracle Cloud Infrastructure Compute Classic

Create a Security IP List

post

/seciplist/

Creates a security IP list. Note that, after creating a security IP list, you can add additional IP addresses to the list by using the POST /seciplist/ HTTP request again with just the additional IP addresses.

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 security IP list that you want to create.

Root Schema : SecIPList-post-request

Type: object

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

Show Source

description(optional): string

A description of the security IP list.
name: string

The three-part name of the object (/Compute-identity_domain/user/object).
Object names can contain only alphanumeric characters, hyphens, underscores, and periods. Object names are case-sensitive.
secipentries: array secipentries

A comma-separated list of the subnets (in CIDR format) or IPv4 addresses for which you want to create this security IP list.
For example, to create a security IP list containing the IP addresses 203.0.113.1 and 203.0.113.2, enter one of the following:
203.0.113.0/30
203.0.113.1, 203.0.113.2

{
    "required":[
        "name",
        "secipentries"
    ],
    "description":"The request body contains details of the security IP list that you want to create. ",
    "properties":{
        "description":{
            "type":"string",
            "description":"<p>A description of the security IP list."
        },
        "name":{
            "type":"string",
            "description":"<p>The three-part name of the object (<code>/Compute-<em>identity_domain</em>/<em>user</em>/<em>object</em></code>).<p>Object names can contain only alphanumeric characters, hyphens, underscores, and periods. Object names are case-sensitive."
        },
        "secipentries":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"<p>A comma-separated list of the subnets (in CIDR format) or IPv4 addresses for which you want to create this security IP list.<p>For example, to create a security IP list containing the IP addresses 203.0.113.1 and 203.0.113.2, enter one of the following:<p><code>203.0.113.0/30</code><p><code>203.0.113.1, 203.0.113.2</code>"
        }
    }
}

Nested Schema : secipentries

Type: array

A comma-separated list of the subnets (in CIDR format) or IPv4 addresses for which you want to create this security IP list.

For example, to create a security IP list containing the IP addresses 203.0.113.1 and 203.0.113.2, enter one of the following:

203.0.113.0/30

203.0.113.1, 203.0.113.2

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"<p>A comma-separated list of the subnets (in CIDR format) or IPv4 addresses for which you want to create this security IP list.<p>For example, to create a security IP list containing the IP addresses 203.0.113.1 and 203.0.113.2, enter one of the following:<p><code>203.0.113.0/30</code><p><code>203.0.113.1, 203.0.113.2</code>"
}

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 : SecIPList-response

Type: object

Show Source

description(optional): string

A description of the security IP list.
name(optional): string

The three-part name of the object
secipentries(optional): array secipentries

A comma-separated list of the subnets (in CIDR format) or IPv4 addresses for which you want to create this security IP list.
For example, to create a security IP list containing the IP addresses 203.0.113.1 and 203.0.113.2, enter one of the following:
203.0.113.0/30
203.0.113.1, 203.0.113.2
uri(optional): string

Uniform Resource Identifier

{
    "properties":{
        "description":{
            "type":"string",
            "description":"<p>A description of the security IP list."
        },
        "name":{
            "type":"string",
            "description":"<p>The three-part name of the object"
        },
        "secipentries":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"<p>A comma-separated list of the subnets (in CIDR format) or IPv4 addresses for which you want to create this security IP list.<p>For example, to create a security IP list containing the IP addresses 203.0.113.1 and 203.0.113.2, enter one of the following:<p><code>203.0.113.0/30</code><p><code>203.0.113.1, 203.0.113.2</code>"
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier"
        }
    }
}

Nested Schema : secipentries

Type: array

A comma-separated list of the subnets (in CIDR format) or IPv4 addresses for which you want to create this security IP list.

For example, to create a security IP list containing the IP addresses 203.0.113.1 and 203.0.113.2, enter one of the following:

203.0.113.0/30

203.0.113.1, 203.0.113.2

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"<p>A comma-separated list of the subnets (in CIDR format) or IPv4 addresses for which you want to create this security IP list.<p>For example, to create a security IP list containing the IP addresses 203.0.113.1 and 203.0.113.2, enter one of the following:<p><code>203.0.113.0/30</code><p><code>203.0.113.1, 203.0.113.2</code>"
}

Examples

cURL Command

The following example shows how to add a security IP list 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/seciplist/

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.

{
"secipentries": [
    "46.16.56.0/21",
    "46.6.0.0/16"
  ],
  "name": "/Compute-acme/jack.jones@example.com/es_iplist"
}

Example of Response Body

The following example shows the response body in JSON format.

{
  "secipentries": [
    "46.16.56.0/21",
    "46.6.0.0/16"
  ],
  "name": "/Compute-acme/jack.jones@example.com/es_iplist",
  "uri": "https://api-z999.compute.us0.oraclecloud.com/seciplist/Compute-acme/jack.jones@example.com/es_iplist",
  "group_id": "29295",
  "id": "e9710ec4-51ac-4248-8d82-427851b634e0",
  "description": null
}