REST API for Oracle Cloud Infrastructure Compute Classic

Update a Security IP List

put

/seciplist/{name}

Updates IP addresses and description of the specified security IP list. Note that this command replaces the values in the secipentries and description fields with the new values that you specify. To add one or more IP addresses to the existing list, run the add seciplist command and specify 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

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.

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

Root Schema : SecIPList-put-request

Type: object

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

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).
secipentries: array secipentries

Comma-separated list of IPv4 addresses or subnets or both.

{
    "required":[
        "name",
        "secipentries"
    ],
    "description":"The request body contains details of the security IP list that you want to update. ",
    "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>)."
        },
        "secipentries":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"Comma-separated list of IPv4 addresses or subnets or both."
        }
    }
}

Nested Schema : secipentries

Type: array

Comma-separated list of IPv4 addresses or subnets or both.

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"Comma-separated list of IPv4 addresses or subnets or both."
}

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

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 update a security IP list, /Compute-acme/jack.jones@example.com/es_iplist, 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/seciplist/Compute-acme/jack.jones@example.com/es_iplist

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.

Example of Request Body

The following shows an example of the request body content in the requestbody.json file to update the security IP entries and the description of a security IP list.

{
"secipentries": [
    "203.51.34.0/16",
    "203.60.07.1/24"
  ],
  "name": "/Compute-acme/jack.jones@example.com/es_iplist",
  "description": "updated security IP list"
}

Example of Response Body

The following example shows the response body in JSON format when you update a security IP list.

{
  "secipentries": [
    "203.51.34.0/16",
    "203.60.07.1/24"
  ],
  "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": "updated security IP list"
}