Retrieve Details of all Security Applications in a Container

get

/secapplication/{container}/

Retrieves details of the security applications that are in the specified container and match the specified query criteria. If you don't specify any query criteria, then details of all the security applications in the container are displayed. You can use this HTTP request to validate the results of POST and PUT operations.

To filter the search results, you can pass one or more of the following query parameters, by appending them to the URI in the following syntax:

?parameter1=value1&parameter2=value2&parameterN=valueN

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
Path Parameters
  • /Compute-identity_domain/user or /Compute-identity_domain for user-created security applications and /oracle/public for system-provided security applications.
Query Parameters
  • A description of the security application.

  • 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.

  • 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.

  • 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.

  • The three-part name of the object (/Compute-identity_domain/user/object).
  • 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.

Header Parameters

Response

Supported Media Types

200 Response

OK. See Status Codes for information about other possible HTTP status codes.
Headers
Body ()
Root Schema : SecApplication-list-response
Type: object
Show Source
Nested Schema : result
Type: array
Show Source
Nested Schema : SecApplication-response
Type: object
Show Source
  • A description of the security application.

  • 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.

  • 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.

  • 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.

  • The three-part name of the object (/Compute-identity_domain/user/object).
  • 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.

  • Uniform Resource Identifier

Examples

cURL Command

The following example shows how to retrieve details about all security applications in the /Compute-acme/jack.jones@example.com/ container 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/
  • 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": "tcp",
      "name": "/Compute-acme/jack.jones@example.com/vnc",
      "uri": "https://api-z999.compute.us0.oraclecloud.com/secapplication/Compute-acme/jack.jones@example.com/vnc",
      "icmptype": "",
      "proxyuri": null,
      "dport": "5900-5999",
      "icmpcode": ""
    },
    {
      "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/video_streaming_udp",
      "icmptype": "",
      "proxyuri": null,
      "dport": "70",
      "icmpcode": ""
    }
  ]
}
}