REST API for Oracle Cloud Infrastructure Compute Classic

Retrieve Details of a Security Application

get

/secapplication/{name}

Required Role: To complete this task, you must have the Compute_Monitor or 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.

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

Type: object

Show Source

description(optional): string

A description of the security application.
dport(optional): string

The TCP or UDP destination port number.
You can also specify a port range, such as 5900-5999 for TCP.
If you specify tcp or udp as the protocol, then the dport parameter is required; otherwise, it is optional.
This parameter isn't relevant to the icmp protocol.
Note: This request fails if the range-end is lower than the range-start. For example, if you specify the port range as 5000-4000.
icmpcode(optional): string
The ICMP code.
This parameter is relevant only if you specify icmp as the protocol. You can specify one of the following values:
- network
- host
- protocol
- port
- df
- admin
If you specify icmp as the protocol and don't specify icmptype or icmpcode, then all ICMP packets are matched.
icmptype(optional): string
The ICMP type.
This parameter is relevant only if you specify icmp as the protocol. You can specify one of the following values:
- echo
- reply
- ttl
- traceroute
- unreachable
If you specify icmp as the protocol and don't specify icmptype or icmpcode, then all ICMP packets are matched.
name(optional): string

The three-part name of the object (/Compute-identity_domain/user/object).
protocol(optional): string

The protocol to use.
The value that you specify can be either a text representation of a protocol or any unsigned 8-bit assigned protocol number in the range 0-254. See Assigned Internet Protocol Numbers.
For example, you can specify either tcp or the number 6.
The following text representations are allowed: tcp, udp, icmp, igmp, ipip, rdp, esp, ah, gre, icmpv6, ospf, pim, sctp, mplsip, all.
To specify all protocols, set this to all.
uri(optional): string

Uniform Resource Identifier

{
    "properties":{
        "description":{
            "type":"string",
            "description":"<p>A description of the security application."
        },
        "dport":{
            "type":"string",
            "description":"<p>The TCP or UDP destination port number.<p>You can also specify a port range, such as 5900-5999 for TCP.<p>If you specify <code>tcp</code> or <code>udp</code> as the protocol, then the <code>dport</code> parameter is required; otherwise, it is optional.<p>This parameter isn't relevant to the <code>icmp</code> protocol.<p><b>Note:</b> This request fails if the range-end is lower than the range-start. For example, if you specify the port range as 5000-4000."
        },
        "icmpcode":{
            "type":"string",
            "description":"The ICMP code.<p>This parameter is relevant only if you specify <code>icmp</code> as the protocol. You can specify one of the following values:<ul><li><code>network</code></li><li><code>host</code></li><li><code>protocol</code></li><li><code>port</code></li><li><code>df</code></li><li><code>admin</code></li></ul><p>If you specify <code>icmp</code> as the protocol and don't specify <code>icmptype</code> or <code>icmpcode</code>, then all ICMP packets are matched."
        },
        "icmptype":{
            "type":"string",
            "description":"The ICMP type.<p>This parameter is relevant only if you specify <code>icmp</code> as the protocol. You can specify one of the following values:<ul><li><code>echo</code></li><li><code>reply</code></li><li><code>ttl</code></li><li><code>traceroute</code></li><li><code>unreachable</code></li></ul><p>If you specify <code>icmp</code> as the protocol and don't specify <code>icmptype</code> or <code>icmpcode</code>, then all ICMP packets are matched."
        },
        "name":{
            "type":"string",
            "description":"The three-part name of the object (<code>/Compute-<em>identity_domain</em>/<em>user</em>/<em>object</em></code>)."
        },
        "protocol":{
            "type":"string",
            "description":"The protocol to use.<p>The value that you specify can be either a text representation of a protocol or any unsigned 8-bit assigned protocol number in the range 0-254. See <a target=\"_blank\" href=\"http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml\">Assigned Internet Protocol Numbers</a>.<p>For example, you can specify either tcp or the number 6.<p>The following text representations are allowed: <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>To specify all protocols, set this to <code>all</code>."
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier"
        }
    }
}

Examples

cURL Command

The following example shows how to view details of a security application by submitting a GET 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 -X GET 
     -H "Cookie: $COMPUTE_COOKIE"
     -H "Accept: application/oracle-compute-v3+json"
     https://api-z999.compute.us0.oraclecloud.com/secapplication/Compute-acme/jack.jones@example.com/vid_stream_udp

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 Response Body

The following example shows the response body in JSON format.

{
"result": 
[
{
 "protocol": "udp",
 "name": "/Compute-acme/jack.jones@example.com/video_streaming_udp",
 "uri": "https://api-z999.compute.us0.oraclecloud.com/secapplication/Compute-acme/jack.jones@example.com/vid_stream_udp",
 "icmptype": "",
 "dport": "70",
 "icmpcode": ""
}
]
}