REST API for Oracle Cloud Infrastructure Compute Classic

Update a Security Protocol Used in IP Networks

put

/network/v1/secprotocol/{name}

Update an existing security protocol. You can update values of the description, ipProtocol, srcPortSet, dstPortSet, and tags parameters of a security protocol.

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 protocol that you want to update.

Root Schema : SecurityProtocol-put-request

Type: object

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

Show Source

description(optional): string

Description of the security protocol.
dstPortSet(optional): array dstPortSet

Enter a list of port numbers or port range strings. Traffic is enabled by a security rule when a packet's destination port matches the ports specified here.
For TCP, SCTP, and UDP, each port is a destination transport port, between 0 and 65535, inclusive. For ICMP, each port is an ICMP type, between 0 and 255, inclusive.
If no destination ports are specified, all destination ports or ICMP types are allowed.
ipProtocol(optional): string

The protocol used in the data portion of the IP datagram. Specify one of the permitted values or enter a number in the range 0 - 254 to represent the protocol that you want to specify. See Assigned Internet Protocol Numbers. Permitted values are: tcp, udp, icmp, igmp, ipip, rdp, esp, ah, gre, icmpv6, ospf, pim, sctp, mplsip, all.
Traffic is enabled by a security rule when the protocol in the packet matches the protocol specified here. If no protocol is specified, all protocols are allowed.
name: string

The three-part name of the Ip address association (/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.
srcPortSet(optional): array srcPortSet

Enter a list of port numbers or port range strings. Traffic is enabled by a security rule when a packet's source port matches the ports specified here.
For TCP, SCTP, and UDP, each port is a source transport port, between 0 and 65535, inclusive. For ICMP, each port is an ICMP type, between 0 and 255, inclusive.
If no source ports are specified, all source ports or ICMP types are allowed.
tags(optional): array tags

Strings that you can use to tag the security protocol.

{
    "required":[
        "name"
    ],
    "description":"The request body contains details of the security protocol that you want to update. ",
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of the security protocol."
        },
        "dstPortSet":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"Enter a list of port numbers or port range strings. Traffic is enabled by a security rule when a packet's destination port matches the ports specified here.<p>For TCP, SCTP, and UDP, each port is a destination transport port, between 0 and 65535, inclusive. For ICMP, each port is an ICMP type, between 0 and 255, inclusive.<p>If no destination ports are specified, all destination ports or ICMP types are allowed."
        },
        "ipProtocol":{
            "type":"string",
            "description":"The protocol used in the data portion of the IP datagram. Specify one of the permitted values or enter a number in the range 0 - 254 to represent the protocol that you want to specify. See <a target=\"_blank\" href=\"http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml\">Assigned Internet Protocol Numbers</a>. Permitted values are: <code>tcp</code>, <code>udp</code>, <code>icmp</code>, <code>igmp</code>, <code>ipip</code>, <code>rdp</code>, <code>esp</code>, <code>ah</code>, <code>gre</code>, <code>icmpv6</code>, <code>ospf</code>, <code>pim</code>, <code>sctp</code>, <code>mplsip</code>, <code>all</code>.<p>Traffic is enabled by a security rule when the protocol in the packet matches the protocol specified here. If no protocol is specified, all protocols are allowed."
        },
        "name":{
            "type":"string",
            "description":"The three-part name of the Ip address association (/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."
        },
        "srcPortSet":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"Enter a list of port numbers or port range strings. Traffic is enabled by a security rule when a packet's source port matches the ports specified here.<p>For TCP, SCTP, and UDP, each port is a source transport port, between 0 and 65535, inclusive. For ICMP, each port is an ICMP type, between 0 and 255, inclusive.<p>If no source ports are specified, all source ports or ICMP types are allowed."
        },
        "tags":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"Strings that you can use to tag the security protocol."
        }
    }
}

Nested Schema : dstPortSet

Type: array

Enter a list of port numbers or port range strings. Traffic is enabled by a security rule when a packet's destination port matches the ports specified here.

For TCP, SCTP, and UDP, each port is a destination transport port, between 0 and 65535, inclusive. For ICMP, each port is an ICMP type, between 0 and 255, inclusive.

If no destination ports are specified, all destination ports or ICMP types are allowed.

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"Enter a list of port numbers or port range strings. Traffic is enabled by a security rule when a packet's destination port matches the ports specified here.<p>For TCP, SCTP, and UDP, each port is a destination transport port, between 0 and 65535, inclusive. For ICMP, each port is an ICMP type, between 0 and 255, inclusive.<p>If no destination ports are specified, all destination ports or ICMP types are allowed."
}

Nested Schema : srcPortSet

Type: array

Enter a list of port numbers or port range strings. Traffic is enabled by a security rule when a packet's source port matches the ports specified here.

For TCP, SCTP, and UDP, each port is a source transport port, between 0 and 65535, inclusive. For ICMP, each port is an ICMP type, between 0 and 255, inclusive.

If no source ports are specified, all source ports or ICMP types are allowed.

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"Enter a list of port numbers or port range strings. Traffic is enabled by a security rule when a packet's source port matches the ports specified here.<p>For TCP, SCTP, and UDP, each port is a source transport port, between 0 and 65535, inclusive. For ICMP, each port is an ICMP type, between 0 and 255, inclusive.<p>If no source ports are specified, all source ports or ICMP types are allowed."
}

Nested Schema : tags

Type: array

Strings that you can use to tag the security protocol.

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"Strings that you can use to tag the security protocol."
}

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

Type: object

Show Source

description(optional): string

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

List of port numbers or port range strings to match the packet's destination port.
ipProtocol(optional): string

Protocol used in the data portion of the IP datagram.
name(optional): string

Name of the security protocol.
srcPortSet(optional): array srcPortSet

List of port numbers or port range strings to match the packet's source port.
tags(optional): array tags

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

Uniform Resource Identifier

{
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of the object."
        },
        "dstPortSet":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"List of port numbers or port range strings to match the packet's destination port."
        },
        "ipProtocol":{
            "type":"string",
            "description":"Protocol used in the data portion of the IP datagram."
        },
        "name":{
            "type":"string",
            "description":"Name of the security protocol."
        },
        "srcPortSet":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"List of port numbers or port range strings to match the packet's source port."
        },
        "tags":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"Tags associated with the object."
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier"
        }
    }
}

Nested Schema : dstPortSet

Type: array

List of port numbers or port range strings to match the packet's destination port.

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"List of port numbers or port range strings to match the packet's destination port."
}

Nested Schema : srcPortSet

Type: array

List of port numbers or port range strings to match the packet's source port.

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"List of port numbers or port range strings to match the packet's source port."
}

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 update a security protocol, /Compute-acme/jack.jones@example.com/secprotocol1, 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/network/v1/secprotocol/Compute-acme/jack.jones@example.com/secprotocol1

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 values of the description, ipProtocol, srcPortSet, and dstPortSet parameters of a security protocol.

{
  "name": "/Compute-acme/jack.jones@example.com/secprotocol1",
  "description": "Updating sample security protocol",
  "ipProtocol": "udp",
  "srcPortSet": ["2010-2022"],
  "dstPortSet": ["2025-2030"]
}

Example of Response Body

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

{
  "name": "/Compute-acme/jack.jones@example.com/secprotocol1",
  "uri": "https://api-z999.compute.us0.oraclecloud.com:443/network/v1/secprotocol/Compute-acme/jack.jones@example.com/secprotocol1",
  "description": "Updating sample security protocol",
  "tags": [],
  "ipProtocol": "udp",
  "srcPortSet": ["2010-2022"],
  "dstPortSet": ["2025-2030"]
}