openapi: 3.2.0 info: title: Oracle Network Firewall API version: '1.0' description: 'Operations tagged networkFirewall across 2 of this provider''s published API definitions: oci-network-firewall-1-openapi.yaml, oci-network-firewall-openapi.yaml. Each path carries the servers of the definition it was published in.' servers: - url: http://127.0.0.1/20220518 - url: https://127.0.0.1/20220518 tags: - name: networkFirewall paths: /networkFirewallPolicies: get: deprecated: true description: 'Returns a list of Network Firewall Policies. ' operationId: ListNetworkFirewallPolicies parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of NetworkFirewallPolicySummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/NetworkFirewallPolicySummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a collection of all Network Firewall Policies in a compartment tags: - networkFirewall x-example: "GET /20211001/networkFirewallPolicies\nHost: network-firewalls.us-ashburn-1.oraclecloud.com\n<authorization and other headers> \n" x-related-resource: '#/definitions/NetworkFirewallPolicy' post: deprecated: true description: 'Creates a new Network Firewall Policy. Support for this operation ended on November 1, 2024. See the [service change announcement](/iaas/Content/servicechanges.htm#NetworkFirewall). We highly recommend upgrading to the 20230501 version of this API to ensure continued functionality and support. ' operationId: CreateNetworkFirewallPolicy parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The NetworkFirewallPolicy will be created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkFirewallPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Network Firewall Policy tags: - networkFirewall x-example: "POST /20211001/networkFirewallPolicies\nHost: network-firewalls.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n\"displayName\": \"MyPolicy\",\n\"compartmentId\": \"ocid1.tenancy.oc1..<unique_ID>\",\n\"applicationLists\": {\n \"MyAppList\": [\n {\n \"type\": \"TCP\",\n \"minimumPort\": 80,\n \"maximumPort\": 8080\n }\n ]\n},\n\"urlLists\": {\n \"MyURLList\": [\n {\n \"type\": \"SIMPLE\",\n \"pattern\": \"www.oracle.com\"\n }\n ]\n},\n\"ipAddressLists\": {\n \"MyIPAddressList\": [\n \"10.0.0.1\"\n ]\n},\n\"mappedSecrets\": {\n \"MyMappedSecret\": {\n \"type\": \"SSL_INBOUND_INSPECTION\",\n \"vaultSecretId\": \"ocid1.vaultsecret.oc1.iad.<unique_ID>\",\n \"versionNumber\": 1,\n \"source\": \"OCI_VAULT\"\n }\n},\n\"decryptionProfiles\": {\n \"MyDecryptionProfile\": {\n \"type\": \"SSL_INBOUND_INSPECTION\",\n \"isUnsupportedVersionBlocked\": true,\n \"isUnsupportedCipherBlocked\": true,\n \"isOutOfCapacityBlocked\": false\n }\n},\n\"securityRules\": [\n {\n \"name\": \"SecurityRuleA\",\n \"condition\": {\n \"sources\": [],\n \"destinations\": [\n \"MyIPAddressList\"\n ],\n \"applications\": [],\n \"urls\": [\n \"MyURLList\"\n ]\n },\n \"action\": \"ALLOW\"\n },\n {\n \"name\": \"SecurityRuleB\",\n \"condition\": {\n \"sources\": [\n \"MyIPAddressList\"\n ],\n \"destinations\": [],\n \"applications\": [\n \"MyAppList\"\n ],\n \"urls\": [\n \"MyURLList\"\n ]\n },\n \"action\": \"INSPECT\",\n \"inspection\": \"INTRUSION_DETECTION\"\n }\n],\n\"decryptionRules\": [\n {\n \"name\": \"MyDecryptionRule\",\n \"condition\": {\n \"sources\": [],\n \"destinations\": [\n \"MyIPAddressList\"\n ]\n },\n \"action\": \"DECRYPT\",\n \"decryptionProfile\": \"MyDecryptionProfile\",\n \"secret\": \"MyMappedSecret\"\n }\n],\n\"freeformTags\": {},\n\"definedTags\": {}\n} \n" x-related-resource: '#/definitions/NetworkFirewallPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNetworkFirewallPolicyDetails' description: Request Details to create the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}: delete: deprecated: true description: 'Deletes a NetworkFirewallPolicy resource with the given identifier. Support for this operation ended on February 1, 2025. See the [service change announcement](/iaas/Content/servicechanges.htm#NetworkFirewall). We highly recommend upgrading to the 20230501 version of this API to ensure continued functionality and support. ' operationId: DeleteNetworkFirewallPolicy parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The NetworkFirewallPolicy will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a NetworkFirewallPolicy tags: - networkFirewall x-example: 'DELETE /20211001/networkFirewallPolicies/<firewallId> Host: network-firewalls.us-ashburn-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/NetworkFirewallPolicy' get: deprecated: true description: 'Gets a NetworkFirewallPolicy given the network firewall policy identifier. Support for this operation ended on January 1, 2025. See the [service change announcement](/iaas/Content/servicechanges.htm#NetworkFirewall). We highly recommend upgrading to the 20230501 version of this API to ensure continued functionality and support. ' operationId: GetNetworkFirewallPolicy parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the NetworkFirewallPolicy with the given id headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkFirewallPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get NetworkFirewallPolicy resource. tags: - networkFirewall x-example: 'GET /20211001/networkFirewallPolicies/<networkFirewallPolicyId> Host: network-firewalls.us-ashburn-1.oraclecloud.com <authorization and other headers> ' put: deprecated: true description: 'Updates the NetworkFirewallPolicy resource. Support for this operation ended on November 1, 2024. See the [service change announcement](/iaas/Content/servicechanges.htm#NetworkFirewall). We highly recommend upgrading to the 20230501 version of this API to ensure continued functionality and support. ' operationId: UpdateNetworkFirewallPolicy parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The NetworkFirewallPolicy will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the NetworkFirewallPolicy using the id tags: - networkFirewall x-example: "PUT /20211001/networkFirewallPolicies/<networkFirewallPolicyId>\nHost: network-firewalls.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n\"displayName\": \"NewPolicyName\",\n} \n" x-related-resource: '#/definitions/NetworkFirewallPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNetworkFirewallPolicyDetails' description: The information to be updated. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/actions/changeCompartment: post: deprecated: true description: Moves a NetworkFirewallPolicy resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeNetworkFirewallPolicyCompartment parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: Processed the request. The NetworkFirewallPolicy resource moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - networkFirewall x-example: "POST /20211001/networkFirewallPolicies/<networkFirewallPolicyId>/actions/changeCompartment\nHost: network-firewalls.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n} \n" x-related-resource: '#/definitions/NetworkFirewallPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeNetworkFirewallPolicyCompartmentDetails' description: The information to be updated. required: true /networkFirewalls: get: description: 'Returns a list of NetworkFirewalls. ' operationId: ListNetworkFirewalls parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/NetworkFirewallPolicyIdQueryParam' - $ref: '#/components/parameters/NetworkFirewallIdentifierQueryParam' - $ref: '#/components/parameters/AvailabilityDomainQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of NetworkFirewallSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/NetworkFirewallCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all NetworkFirewalls in a compartment tags: - networkFirewall x-example: 'GET /20211001/networkFirewalls Host: network-firewalls.us-ashburn-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/NetworkFirewall' post: description: 'Creates a new NetworkFirewall. ' operationId: CreateNetworkFirewall parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The NetworkFirewall will be created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkFirewall' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new NetworkFirewall tags: - networkFirewall x-example: "POST /20211001/networkFirewalls\nHost: network-firewalls.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n {\n \"displayName\": \"MyFirewall\",\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_ID>\",\n \"subnetId\": \"ocid1.subnet.oc1.iad.<unique_ID>\",\n \"availabilityDomain\": \"EMIr:US-ASHBURN-AD-1\",\n \"networkSecurityGroupIds\": [],\n \"networkFirewallPolicyId\": \"ocid1.networkfirewallpolicy.oc1.iad.<unique_ID>\",\n \"definedTags\": {},\n \"freeformTags\": {}\n }\n" x-related-resource: '#/definitions/NetworkFirewall' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNetworkFirewallDetails' description: Details for the new NetworkFirewall. required: true /networkFirewalls/{networkFirewallId}: delete: description: Deletes a NetworkFirewall resource by identifier operationId: DeleteNetworkFirewall parameters: - $ref: '#/components/parameters/NetworkFirewallIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The NetworkFirewall will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned NetworkFirewall tags: - networkFirewall x-example: 'DELETE /20211001/networkFirewalls/<networkFirewallId> Host: network-firewalls.us-ashburn-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/NetworkFirewall' get: description: Gets a NetworkFirewall by identifier operationId: GetNetworkFirewall parameters: - $ref: '#/components/parameters/NetworkFirewallIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the NetworkFirewall with the given id headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkFirewall' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get NetworkFirewall tags: - networkFirewall x-example: 'GET /20211001/networkFirewalls/<networkFirewallId> Host: network-firewalls.us-ashburn-1.oraclecloud.com <authorization and other headers> ' put: description: Updates the NetworkFirewall operationId: UpdateNetworkFirewall parameters: - $ref: '#/components/parameters/NetworkFirewallIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The NetworkFirewall will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the NetworkFirewall identified by the id tags: - networkFirewall x-example: "PUT /20211001/networkFirewalls/<networkFirewallId>\nHost: network-firewalls.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n {\n \"displayName\": \"UpdatedFirewallName\"\n }\n" x-related-resource: '#/definitions/NetworkFirewall' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNetworkFirewallDetails' description: The information to be updated. required: true /networkFirewalls/{networkFirewallId}/actions/changeCompartment: post: description: Moves a NetworkFirewall resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeNetworkFirewallCompartment parameters: - $ref: '#/components/parameters/NetworkFirewallIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The NetworkFirewall resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - networkFirewall x-example: "POST /20211001/networkFirewalls/<networkFirewallId>/actions/changeCompartment\nHost: network-firewalls.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/NetworkFirewall' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeNetworkFirewallCompartmentDetails' description: The information to be updated. required: true /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List Work Requests tags: - networkFirewall x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: delete: description: Cancel work request with the given ID. operationId: CancelWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The work request will be cancelled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancel the work request tags: - networkFirewall x-related-resource: '#/definitions/WorkRequest' get: description: Gets the status of the work request with the given ID. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The detail of the work request. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: GET Work Request Status tags: - networkFirewall x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Return a (paginated) list of errors for a given work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: List of work request errors. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request errors tags: - networkFirewall x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Return a (paginated) list of logs for a given work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: List of work request logs. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request logs tags: - networkFirewall x-related-resource: '#/definitions/WorkRequestLogEntry' /networkFirewallPolicies/{networkFirewallPolicyId}/actions/applyPolicy: post: description: Applies the candidate version of the NetworkFirewallPolicy resource. When provided, If-Match is checked against ETag values of the resource. operationId: ApplyNetworkFirewallPolicy parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 201: description: Applying the Network Firewall policy initiated. The work-request tracks the apply. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkFirewallPolicy_2' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Apply a new policy configuration into a existing policy. tags: - networkFirewall x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/NetworkFirewallPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplyNetworkFirewallPolicyDetails' description: The information to be updated. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/actions/clonePolicy: post: description: Clones a NetworkFirewallPolicy resource from an existing Network Firewall Policy. When provided, If-Match is checked against ETag values of the resource. operationId: CloneNetworkFirewallPolicy parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 201: description: Cloning of policy initiated. The work-request tracks the clone. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkFirewallPolicy_2' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Clones a existing policy configuration into a new policy. tags: - networkFirewall x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/NetworkFirewallPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/CloneNetworkFirewallPolicyDetails' description: The information to be updated. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/actions/migrate: post: description: Moves a NetworkFirewallPolicy resource from one version to latest version. When provided, If-Match is checked against ETag values of the resource. operationId: MigrateNetworkFirewallPolicy parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The NetworkFirewallPolicy will be migrated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource from current version to latest version. tags: - networkFirewall x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/NetworkFirewallPolicy' /networkFirewallPolicies/{networkFirewallPolicyId}/addressLists: get: description: 'Returns a list of Network Firewall Policies. ' operationId: ListAddressLists parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/DisplayNameQueryParam' responses: 200: description: A page of Address List summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/AddressListSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a collection of all Address Lists in a Network Firewall Policy. tags: - networkFirewall x-related-resource: '#/definitions/AddressList' post: description: 'Creates a new Address List for the Network Firewall Policy. ' operationId: CreateAddressList parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Address List has been created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AddressList' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Address List for the Network Firewall Policy tags: - networkFirewall x-related-resource: '#/definitions/AddressList' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAddressListDetails' description: Request Details to create the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/addressLists/actions/bulkUpload: post: description: 'Creates a new Address Lists at bulk for the Network Firewall Policy. ' operationId: BulkUploadAddressLists parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The Address Lists will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Address Lists at bulk for the Network Firewall Policy as per the content list. tags: - networkFirewall x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/AddressList' requestBody: content: application/json: schema: format: binary type: string description: Request Details to create the Address Lists for the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/addressLists/{addressListName}: delete: description: Deletes a Address List resource with the given identifier. operationId: DeleteAddressList parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/AddressListNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The AddressList is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a Address List with the given name. tags: - networkFirewall x-related-resource: '#/definitions/AddressList' get: description: Get Address List by the given name in the context of network firewall policy. operationId: GetAddressList parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/AddressListNameIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Address List with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AddressList' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Address List by the given name in the context of network firewall policy. tags: - networkFirewall put: description: Updates the Address list with the given name in the network firewall policy. operationId: UpdateAddressList parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/AddressListNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updates the Address List with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/AddressList' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Address List using the name. tags: - networkFirewall x-related-resource: '#/definitions/AddressList' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAddressListDetails' description: The information to be updated. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/applicationGroups: get: description: 'Returns a list of ApplicationGroups for the policy. ' operationId: ListApplicationGroups parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/DisplayNameQueryParam' responses: 200: description: A page of ApplicationGroup Summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ApplicationGroupSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a collection of all ApplicationGroups for the Network Firewall Policy. tags: - networkFirewall x-related-resource: '#/definitions/ApplicationGroup' post: description: 'Creates a new ApplicationGroup for the Network Firewall Policy. ' operationId: CreateApplicationGroup parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ApplicationGroup is created against the policy. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ApplicationGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new ApplicationGroup for the Network Firewall Policy tags: - networkFirewall x-related-resource: '#/definitions/ApplicationGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateApplicationGroupDetails' description: Request Details to create the ApplicationGroup for the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/applicationGroups/actions/bulkUpload: post: description: 'Creates a new Application Group at bulk for the Network Firewall Policy. ' operationId: BulkUploadApplicationGroups parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The Application Groups will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Application Group at bulk for the Network Firewall Policy as per the content list. tags: - networkFirewall x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ApplicationGroup' requestBody: content: application/json: schema: format: binary type: string description: Request Details to create the Application Group for the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/applicationGroups/{applicationGroupName}: delete: description: Deletes a ApplicationGroup resource with the given identifier. operationId: DeleteApplicationGroup parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/ApplicationGroupNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The ApplicationGroup is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a ApplicationGroup with the given name. tags: - networkFirewall x-related-resource: '#/definitions/ApplicationGroup' get: description: Get ApplicationGroup by the given name in the context of network firewall policy. operationId: GetApplicationGroup parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/ApplicationGroupNameIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the ApplicationGroup with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ApplicationGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get ApplicationGroup by the given name in the context of network firewall policy. tags: - networkFirewall put: description: Updates the ApplicationGroup with the given name in the network firewall policy. operationId: UpdateApplicationGroup parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/ApplicationGroupNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updates the ApplicationGroup with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ApplicationGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the ApplicationGroup using the name. tags: - networkFirewall x-related-resource: '#/definitions/ApplicationGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateApplicationGroupDetails' description: The information to be updated. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/applications: get: description: 'Returns a list of Applications for the policy. ' operationId: ListApplications parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/DisplayNameQueryParam' responses: 200: description: A page of Application Summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ApplicationSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a collection of all Applications for the Network Firewall Policy. tags: - networkFirewall x-related-resource: '#/definitions/Application' post: description: 'Creates a new Application for the Network Firewall Policy. ' operationId: CreateApplication parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Application is created against the policy. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Application_2' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Application for the Network Firewall Policy tags: - networkFirewall x-related-resource: '#/definitions/Application' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateApplicationDetails' description: Request Details to create the Application for the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/applications/actions/bulkUpload: post: description: 'Creates new Applications at bulk for the Network Firewall Policy. ' operationId: BulkUploadApplications parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The Applications will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates new Applications at bulk for the Network Firewall Policy as per the content list. tags: - networkFirewall x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Application' requestBody: content: application/json: schema: format: binary type: string description: Request Details to create the Applications for the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/applications/{applicationName}: delete: description: Deletes a Application resource with the given identifier. operationId: DeleteApplication parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/ApplicationNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The Application is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a Application with the given name. tags: - networkFirewall x-related-resource: '#/definitions/Application' get: description: Get Application by the given name in the context of network firewall policy. operationId: GetApplication parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/ApplicationNameIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: Retrieves the Application with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Application_2' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Application by the given name in the context of network firewall policy. tags: - networkFirewall put: description: Updates the Application with the given name in the network firewall policy. operationId: UpdateApplication parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/ApplicationNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updates the Application with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/Application_2' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Application using the name. tags: - networkFirewall x-related-resource: '#/definitions/Application' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateApplicationDetails' description: The information to be updated. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/decryptionProfiles: get: description: 'Returns a list of Decryption Profile for the Network Firewall Policy. ' operationId: ListDecryptionProfiles parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/DisplayNameQueryParam' responses: 200: description: A page of Decryption Profile summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/DecryptionProfileSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a collection of all Decryption Profile for the Network Firewall Policy in a compartment tags: - networkFirewall x-related-resource: '#/definitions/DecryptionProfile' post: description: 'Creates a new Decryption Profile for the Network Firewall Policy. ' operationId: CreateDecryptionProfile parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Created the decrpytion profile successfully. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DecryptionProfile_2' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Decryption Profile for the Network Firewall Policy tags: - networkFirewall x-related-resource: '#/definitions/DecryptionProfile' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDecryptionProfileDetails' description: Request Details to create the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/decryptionProfiles/actions/bulkUpload: post: description: 'Creates new Decryption Profiles at bulk for the Network Firewall Policy. ' operationId: BulkUploadDecryptionProfiles parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The Decryption Profiles will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates new Decryption Profiles at bulk for the Network Firewall Policy as per the content list. tags: - networkFirewall x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/DecryptionProfile' requestBody: content: application/json: schema: format: binary type: string description: Request Details to create the Decryption Profile for the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/decryptionProfiles/{decryptionProfileName}: delete: description: Deletes a Decryption Profile resource with the given identifier. operationId: DeleteDecryptionProfile parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/DecryptionProfileNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The Decryption Profile is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a Decryption Profile with the given name. tags: - networkFirewall x-related-resource: '#/definitions/DecryptionProfile' get: description: Get Decryption Profile by the given name in the context of network firewall policy. operationId: GetDecryptionProfile parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/DecryptionProfileNameIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Decryption Profile with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DecryptionProfile_2' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Decryption Profile by the given name in the context of network firewall policy. tags: - networkFirewall put: description: Updates the Decryption Profile with the given name in the network firewall policy. operationId: UpdateDecryptionProfile parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/DecryptionProfileNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updates the Decryption Profile with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DecryptionProfile_2' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Decryption Profile using the name. tags: - networkFirewall x-related-resource: '#/definitions/DecryptionProfile' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDecryptionProfileDetails' description: The information to be updated. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/decryptionRules: get: description: 'Returns a list of Decryption Rule for the Network Firewall Policy. ' operationId: ListDecryptionRules parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/DecryptionRuleOrderQueryParam' responses: 200: description: A page of Decryption Rule summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/DecryptionRuleSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a collection of all Decryption Rule for the Network Firewall Policy in a compartment tags: - networkFirewall x-related-resource: '#/definitions/DecryptionRule' post: description: 'Creates a new Decryption Rule for the Network Firewall Policy. ' operationId: CreateDecryptionRule parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The Decryption Rule will be created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DecryptionRule_2' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Decryption Rule for the Network Firewall Policy tags: - networkFirewall x-related-resource: '#/definitions/DecryptionRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDecryptionRuleDetails' description: Request Details to create the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/decryptionRules/actions/bulkUpload: post: description: 'Creates Decryption Rules at bulk for the Network Firewall Policy. ' operationId: BulkUploadDecryptionRules parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The Decryption Rules will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates Decryption Rules at bulk for the Network Firewall Policy as per the content list. tags: - networkFirewall x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/DecryptionRule' requestBody: content: application/json: schema: format: binary type: string description: Request Details to create the Decryption Rule for the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/decryptionRules/{decryptionRuleName}: delete: description: Deletes a Decryption Rule resource with the given identifier. operationId: DeleteDecryptionRule parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/DecryptionRuleNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The Decryption Rule is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a Decryption Rule with the given name. tags: - networkFirewall x-related-resource: '#/definitions/DecryptionRule' get: description: Get Decryption Rule by the given name in the context of network firewall policy. operationId: GetDecryptionRule parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/DecryptionRuleNameIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: Retrieves the Decryption Rule with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DecryptionRule_2' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Decryption Rule by the given name in the context of network firewall policy. tags: - networkFirewall put: description: Updates the Decryption Rule with the given name in the network firewall policy. operationId: UpdateDecryptionRule parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/DecryptionRuleNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updates the Decryption Rule with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DecryptionRule_2' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Decryption Rule using the name. tags: - networkFirewall x-related-resource: '#/definitions/DecryptionRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDecryptionRuleDetails' description: The information to be updated. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/mappedSecrets: get: description: 'Returns a list of Mapped Secret for the Network Firewall Policy. ' operationId: ListMappedSecrets parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/DisplayNameQueryParam' responses: 200: description: A page of Mapped Secret summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/MappedSecretSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a collection of all Mapped Secret for the Network Firewall Policy in a compartment tags: - networkFirewall x-related-resource: '#/definitions/MappedSecret' post: description: 'Creates a new Mapped Secret for the Network Firewall Policy. ' operationId: CreateMappedSecret parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The Mapped Secret will be created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MappedSecret_2' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Mapped Secret List for the Network Firewall Policy tags: - networkFirewall x-related-resource: '#/definitions/MappedSecret' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMappedSecretDetails' description: Request Details to create the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/mappedSecrets/actions/bulkUpload: post: description: 'Creates new Mapped Secrets at bulk for the Network Firewall Policy. ' operationId: BulkUploadMappedSecrets parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The Mapped Secrets will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Mapped Secret at bulk for the Network Firewall Policy as per the content list. tags: - networkFirewall x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/MappedSecret' requestBody: content: application/json: schema: format: binary type: string description: Request Details to create the Mapped Secret for the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/mappedSecrets/{mappedSecretName}: delete: description: Deletes a Mapped Secret resource with the given identifier. operationId: DeleteMappedSecret parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/MappedSecretNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The Mapped Secret is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a Mapped Secret with the given name. tags: - networkFirewall x-related-resource: '#/definitions/MappedSecret' get: description: Get Mapped Secret by the given name in the context of network firewall policy. operationId: GetMappedSecret parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/MappedSecretNameIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: Retrieves the Mapped Secret List with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MappedSecret_2' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Mapped Secret by the given name in the context of network firewall policy. tags: - networkFirewall put: description: Updates the Mapped Secret with the given name in the network firewall policy. operationId: UpdateMappedSecret parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/MappedSecretNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updates the Mapped Secret List with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/MappedSecret_2' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Mapped Secret using the name. tags: - networkFirewall x-related-resource: '#/definitions/MappedSecret' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMappedSecretDetails' description: The information to be updated. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/natRules: get: description: 'Returns a list of [NAT rules](/iaas/Content/network-firewall/policies.htm#network-firewall-policies__nat) for the Network Firewall policy. ' operationId: ListNatRules parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/NatRuleOrderQueryParam' responses: 200: description: A page of NAT rule summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/NatRuleCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a collection of all for the Network Firewall policy in a compartment tags: - networkFirewall x-related-resource: '#/definitions/NatRule' post: description: 'Creates a new [NAT rule](/iaas/Content/network-firewall/policies.htm#network-firewall-policies__nat) for the Network Firewall policy. ' operationId: CreateNatRule parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The request is successful and the NAT rule has been created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NatRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new NAT Rule for the Network Firewall Policy tags: - networkFirewall x-related-resource: '#/definitions/NatRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNatRuleDetails' description: Request details used to create NAT rule under a Network Firewall policy resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/natRules/actions/bulkUpload: post: description: 'Creates a new [NAT rule](/iaas/Content/network-firewall/policies.htm#network-firewall-policies__nat) at bulk for the Network Firewall policy. ' operationId: BulkUploadNatRules parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The NAT rules will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new NAT Rule at bulk for the Network Firewall Policy as per the content list. tags: - networkFirewall x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/NatRule' requestBody: content: application/json: schema: format: binary type: string description: Request details to create the NAT rule for the Network Firewall policy resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/natRules/{natRuleName}: delete: description: Deletes a [NAT rule](/iaas/Content/network-firewall/policies.htm#network-firewall-policies__nat) resource with the given identifier. operationId: DeleteNatRule parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/NatRuleNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The NAT rule is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a NAT rule with the given name. tags: - networkFirewall x-related-resource: '#/definitions/NatRule' get: description: Get a [NAT rule](/iaas/Content/network-firewall/policies.htm#network-firewall-policies__nat) by the given name in the context of Network Firewall policy. operationId: GetNatRule parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/NatRuleNameIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the NAT rule with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NatRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get NAT Rule by the given name in the context of network firewall policy. tags: - networkFirewall put: description: Updates the [NAT rule](/iaas/Content/network-firewall/policies.htm#network-firewall-policies__nat) with the given name in the Network Firewall policy. operationId: UpdateNatRule parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/NatRuleNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updates the NAT rule with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NatRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the NAT rule using the name. tags: - networkFirewall x-related-resource: '#/definitions/NatRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNatRuleDetails' description: The information to be updated. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/securityRules: get: description: 'Returns a list of Security Rule for the Network Firewall Policy. ' operationId: ListSecurityRules parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SecurityRuleOrderQueryParam' responses: 200: description: A page of Security Rule summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/SecurityRuleSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a collection of all Security Rule for the Network Firewall Policy in a compartment tags: - networkFirewall x-related-resource: '#/definitions/SecurityRule' post: description: 'Creates a new Security Rule for the Network Firewall Policy. ' operationId: CreateSecurityRule parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The Security Rule will be created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityRule_2' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Security Rule for the Network Firewall Policy tags: - networkFirewall x-related-resource: '#/definitions/SecurityRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSecurityRuleDetails' description: Request Details to create the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/securityRules/actions/bulkUpload: post: description: 'Creates a new Security Rule at bulk for the Network Firewall Policy. ' operationId: BulkUploadSecurityRules parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The Security Rules will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Security Rule at bulk for the Network Firewall Policy as per the content list. tags: - networkFirewall x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/SecurityRule' requestBody: content: application/json: schema: format: binary type: string description: Request Details to create the Security Rule for the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/securityRules/{securityRuleName}: delete: description: Deletes a Security Rule resource with the given identifier. operationId: DeleteSecurityRule parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/SecurityRuleNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The Security Rule is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a Security Rule with the given name. tags: - networkFirewall x-related-resource: '#/definitions/SecurityRule' get: description: Get Security Rule by the given name in the context of network firewall policy. operationId: GetSecurityRule parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/SecurityRuleNameIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Security Rule with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityRule_2' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Security Rule by the given name in the context of network firewall policy. tags: - networkFirewall put: description: Updates the Security Rule with the given name in the network firewall policy. operationId: UpdateSecurityRule parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/SecurityRuleNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updates the Security Rule with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityRule_2' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Security Rule using the name. tags: - networkFirewall x-related-resource: '#/definitions/SecurityRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSecurityRuleDetails' description: The information to be updated. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/serviceLists: get: description: 'Returns a list of ServiceLists for the policy. ' operationId: ListServiceLists parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/DisplayNameQueryParam' responses: 200: description: A page of ServiceList Summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ServiceListSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a collection of all ServiceLists for the Network Firewall Policy. tags: - networkFirewall x-related-resource: '#/definitions/ServiceList' post: description: 'Creates a new ServiceList for the Network Firewall Policy. ' operationId: CreateServiceList parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: ServiceList is created against the policy. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ServiceList' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new ServiceList for the Network Firewall Policy tags: - networkFirewall x-related-resource: '#/definitions/ServiceList' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateServiceListDetails' description: Request Details to create the ServiceList for the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/serviceLists/actions/bulkUpload: post: description: 'Creates a new Service List at bulk for the Network Firewall Policy. ' operationId: BulkUploadServiceLists parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The Service Lists will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Service List at bulk for the Network Firewall Policy as per the content list. tags: - networkFirewall x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ServiceList' requestBody: content: application/json: schema: format: binary type: string description: Request Details to create the Service List for the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/serviceLists/{serviceListName}: delete: description: Deletes a ServiceList resource with the given identifier. operationId: DeleteServiceList parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/ServiceListNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The ServiceList is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a ServiceList with the given name. tags: - networkFirewall x-related-resource: '#/definitions/ServiceList' get: description: Get ServiceList by the given name in the context of network firewall policy. operationId: GetServiceList parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/ServiceListNameIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the ServiceList with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ServiceList' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get ServiceList by the given name in the context of network firewall policy. tags: - networkFirewall put: description: Updates the ServiceList with the given name in the network firewall policy. operationId: UpdateServiceList parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/ServiceListNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updates the ServiceList with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ServiceList' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the ServiceList using the name. tags: - networkFirewall x-related-resource: '#/definitions/ServiceList' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateServiceListDetails' description: The information to be updated. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/services: get: description: 'Returns a list of Services for the policy. ' operationId: ListServices parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/DisplayNameQueryParam' responses: 200: description: A page of Service Summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ServiceSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a collection of all Services for the Network Firewall Policy. tags: - networkFirewall x-related-resource: '#/definitions/Service' post: description: 'Creates a new Service for the Network Firewall Policy. ' operationId: CreateService parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Service is created against the policy. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Service' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Service for the Network Firewall Policy tags: - networkFirewall x-related-resource: '#/definitions/Service' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateServiceDetails' description: Request Details to create the Service for the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/services/actions/bulkUpload: post: description: 'Creates new Services at bulk for the Network Firewall Policy. ' operationId: BulkUploadServices parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The Services will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates new Services at bulk for the Network Firewall Policy as per the content list. tags: - networkFirewall x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Service' requestBody: content: application/json: schema: format: binary type: string description: Request Details to create the Services for the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/services/{serviceName}: delete: description: Deletes a Service resource with the given identifier. operationId: DeleteService parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/ServiceNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The Service is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a Service with the given name. tags: - networkFirewall x-related-resource: '#/definitions/Service' get: description: Get Service by the given name in the context of network firewall policy. operationId: GetService parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/ServiceNameIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: Retrieves the Service with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Service' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Service by the given name in the context of network firewall policy. tags: - networkFirewall put: description: Updates the Service with the given name in the network firewall policy. operationId: UpdateService parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/ServiceNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updates the Service with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/Service' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Service using the name. tags: - networkFirewall x-related-resource: '#/definitions/Service' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateServiceDetails' description: The information to be updated. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/tunnelInspectionRules: get: description: 'Returns a list of tunnel inspection rules for the network firewall policy. ' operationId: ListTunnelInspectionRules parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/TunnelInspectionRuleOrderQueryParam' responses: 200: description: A page of tunnel inspection rule summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/TunnelInspectionRuleSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a collection of all tunnel inspection rules for the network firewall policy in a compartment. tags: - networkFirewall x-related-resource: '#/definitions/TunnelInspectionRule' post: description: 'Creates a new tunnel inspection rule for the network firewall policy. ' operationId: CreateTunnelInspectionRule parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the request. The tunnel inspection rule is be created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TunnelInspectionRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new tunnel inspection rule for the network firewall policy. tags: - networkFirewall x-related-resource: '#/definitions/TunnelInspectionRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTunnelInspectionRuleDetails' description: Request Details to create the network firewall policy resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/tunnelInspectionRules/actions/bulkUpload: post: description: 'Creates a new Tunnel Inspection Rule at bulk for the Network Firewall Policy. ' operationId: BulkUploadTunnelInspectionRules parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The tunnel inspection rules will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new tunnel inspection rule at bulk for the network firewall policy as per the content list. tags: - networkFirewall x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/TunnelInspectionRule' requestBody: content: application/json: schema: format: binary type: string description: Request details to create the tunnel inspection rule for the network firewall policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/tunnelInspectionRules/{tunnelInspectionRuleName}: delete: description: Deletes a tunnel inspection rule resource with the given identifier. operationId: DeleteTunnelInspectionRule parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/TunnelInspectionRuleNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The tunnel inspection rule is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a tunnel inspection rule with the given name. tags: - networkFirewall x-related-resource: '#/definitions/TunnelInspectionRule' get: description: Get tunnel inspection rule by the given name in the context of network firewall policy. operationId: GetTunnelInspectionRule parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/TunnelInspectionRuleNameIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the tunnel inspection rule with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TunnelInspectionRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get tunnel inspection rule by the given name in the context of network firewall policy. tags: - networkFirewall put: description: Updates the tunnel inspection rule with the given name in the network firewall policy. operationId: UpdateTunnelInspectionRule parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/TunnelInspectionRuleNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updates the tunnel inspection rule with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TunnelInspectionRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the tunnel inspection rule using the name. tags: - networkFirewall x-related-resource: '#/definitions/TunnelInspectionRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTunnelInspectionRuleDetails' description: The information to be updated. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/urlLists: get: description: 'Returns a list of URL lists for the Network Firewall Policy. ' operationId: ListUrlLists parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/DisplayNameQueryParam' responses: 200: description: A page of URL List summary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-page-count: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. This is to get the page counts overall. ' schema: type: string opc-prev-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. This provides the count of total items across pages. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/UrlListSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a collection of all URL lists for the Network Firewall Policy in a compartment tags: - networkFirewall x-related-resource: '#/definitions/UrlList' post: description: 'Creates a new Url List for the Network Firewall Policy. ' operationId: CreateUrlList parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: URL List has been created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UrlList' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new URL List for the Network Firewall Policy tags: - networkFirewall x-related-resource: '#/definitions/UrlList' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUrlListDetails' description: Request Details to create the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/urlLists/actions/bulkUpload: post: description: 'Creates a new Url Lists at bulk for the Network Firewall Policy. ' operationId: BulkUploadUrlLists parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The Url Lists will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Url Lists at bulk for the Network Firewall Policy as per the content list. tags: - networkFirewall x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/UrlList' requestBody: content: application/json: schema: format: binary type: string description: Request Details to create the Url Lists for the Network Firewall Policy Resource. required: true /networkFirewallPolicies/{networkFirewallPolicyId}/urlLists/{urlListName}: delete: description: Deletes a Url List resource with the given identifier. operationId: DeleteUrlList parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/UrlListNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Accepted the request. The URL List is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a Url List with the given name. tags: - networkFirewall x-related-resource: '#/definitions/UrlList' get: description: Get Url List by the given name in the context of network firewall policy. operationId: GetUrlList parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/UrlListNameIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the URL List with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UrlList' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Url List by the given name in the context of network firewall policy. tags: - networkFirewall put: description: Updates the Url list with the given name in the network firewall policy. operationId: UpdateUrlList parameters: - $ref: '#/components/parameters/NetworkFirewallPolicyIdentifierPathParam_2' - $ref: '#/components/parameters/UrlListNameIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updates the URL List with the given name. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UrlList' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Url List using the name. tags: - networkFirewall x-related-resource: '#/definitions/UrlList' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUrlListDetails' description: The information to be updated. required: true /networkFirewalls/{networkFirewallId}/healthStatus: get: description: 'Get Overall health status of Network Firewall ' operationId: GetNetworkFirewallHealthStatus parameters: - $ref: '#/components/parameters/NetworkFirewallIdentifierParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Network Firewall Health Status. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkFirewallHealthStatus' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Overall health status of Network Firewall tags: - networkFirewall x-example: 'GET /20211001/networkFirewalls/{networkFirewallId}/healthStatus Host: network-firewalls.us-ashburn-1.oraclecloud.com <authorization and other headers> ' components: schemas: CreateNetworkFirewallDetails: description: The information about new Network Firewall. properties: availabilityDomain: description: 'Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use [ListAvailabilityDomains](#/en/identity/20160918/AvailabilityDomain/ListAvailabilityDomains) operation. Example: `kIdk:PHX-AD-1` ' maxLength: 255 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the Network Firewall. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string x-default-description: If you do not supply this field, the service will generate a displayName for the Network Firewall. freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ipv4Address: description: IPv4 address for the Network Firewall. maxLength: 15 type: string x-default-description: If you do not supply this field, the service will assign one from the subnet cidr range. ipv6Address: description: IPv6 address for the Network Firewall. maxLength: 45 type: string x-default-description: 'null' natConfiguration: $ref: '#/components/schemas/NatConfigurationRequest' networkFirewallPolicyId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Network Firewall Policy. maxLength: 255 minLength: 1 type: string networkSecurityGroupIds: description: An array of network security groups [OCID](/iaas/Content/General/Concepts/identifiers.htm) associated with the Network Firewall. items: type: string maxItems: 5 type: array securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: {"MaxEgressCount": {"value": "42", "mode": "enforce"}} ' type: object description: '[Security attributes](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing (ZPR)](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/overview.htm) policy to control access to ZPR-supported resources. ' type: object shape: description: The shape of a firewall to determine the bandwidth that the firewall allows. maxLength: 50 type: string subnetId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the Network Firewall. maxLength: 255 minLength: 1 type: string required: - compartmentId - subnetId - networkFirewallPolicyId type: object ApplyNetworkFirewallPolicyDetails: description: Request data required to clone a network firewall policy. properties: firewalls: description: Ordered priority list of firewall OCIDs on which the update needs to be applied in given order. If the list is a subset of the firewalls attached, then given firewalls would be deployed first with the change, followed by remaining firewalls. items: type: string type: array x-default-description: If you do not supply this field, the service will generate a default priority order for attached firewalls and apply the Network Firewall Policy. type: object DecryptionRuleMatchCriteria_2: description: Match criteria used in Decryption Rule used on the firewall policy rules. properties: destinationAddress: description: An array of address list names to be evaluated against the traffic destination address. items: type: string maxItems: 25 minItems: 1 type: array sourceAddress: description: An array of address list names to be evaluated against the traffic source address. items: type: string maxItems: 25 minItems: 1 type: array type: object Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message ApplicationSummary: description: Summary object for application element in the network firewall policy. discriminator: propertyName: type properties: description: description: The description of the application. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name of the application. maxLength: 32 minLength: 2 type: string parentResourceId: description: OCID of the Network Firewall Policy this application belongs to. maxLength: 255 minLength: 1 type: string type: description: Describes the type of Application. enum: - ICMP - ICMP_V6 type: string x-obmcs-top-level-enum: '#/definitions/AppType' required: - type - name - parentResourceId type: object Application: description: 'A protocol identifier (such as TCP, UDP, or ICMP) and protocol-specific parameters (such as a port range). ' discriminator: propertyName: type properties: type: description: Describes the type of Application. type: string required: - type type: object DecryptionRuleMatchCriteria: description: Match criteria used in Decryption Rule used on the firewall policy rules. properties: destinations: description: An array of IP address list names to be evaluated against the traffic destination address. items: type: string maxItems: 25 minItems: 1 type: array sources: description: An array of IP address list names to be evaluated against the traffic source address. items: type: string maxItems: 25 minItems: 1 type: array type: object NatConfigurationRequest: description: "Request to configure Network Address Translation (NAT) on a firewall. \n\nTo perform NAT on traffic passing the private NAT IPs to the firewall, the attached network firewall policy must also have NAT rules and NAT configuration must be enabled. If NAT configuration is enabled and the attached firewall policy does not contain NAT rule then NAT IPs will get allocated but NAT will not be performed on any traffic.\n" properties: mustEnablePrivateNat: description: 'The value of this field must be set to true if the network firewall policy being applied contains NAT rules. The value of this field can be set to false if the network firewall policy being applied or the currently attached firewall policy doesn''t contain NAT rules. ' type: boolean required: - mustEnablePrivateNat type: object SecurityRuleSummaryCollection: description: Collection of Security Rule Summaries in the network firewall policy properties: items: description: Collection of Security Rule Summaries. items: $ref: '#/components/schemas/SecurityRuleSummary' type: array required: - items type: object CreateApplicationGroupDetails: description: Request for creating a application list in a policy. properties: apps: description: Collection of application names. example: - - my-app-1 - my-tcp-app - my-web-app items: type: string maxItems: 500 type: array description: description: The description of the application list. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name of the application Group. maxLength: 28 minLength: 2 type: string required: - name type: object NetworkFirewallPolicy_2: description: Description of NetworkFirewall Policy. properties: attachedNetworkFirewallCount: description: 'Count of number of Network Firewall attached to the Policy. ' type: integer compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the NetworkFirewall Policy. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the network firewall policy. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string displayName: description: A user-friendly optional name for the firewall policy. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource - Network Firewall Policy. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Network Firewall Policy. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The time instant at which the Network Firewall Policy was created in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The time instant at which the Network Firewall Policy was updated in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - timeUpdated - displayName - freeformTags - definedTags type: object AddressListSummary: description: Address List Summary in the network firewall policy properties: description: description: The description of the address list. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name of Address List type: string parentResourceId: description: OCID of the Network Firewall Policy this address list belongs to. maxLength: 255 minLength: 1 type: string totalAddresses: description: Count of total Addresses in the AddressList maximum: 65535 minimum: 0 type: integer type: description: Type of address List. The accepted values are - * FQDN * IP enum: - FQDN - IP type: string x-obmcs-top-level-enum: '#/definitions/AddressListType' required: - name - type - totalAddresses - parentResourceId type: object SecurityRuleMatchCriteria_2: description: 'Criteria to evaluate against network traffic. A match occurs when at least one item in the array associated with each specified property corresponds with the relevant aspect of the traffic. ' properties: application: description: An array of application list names to be evaluated against the traffic protocol and protocol-specific parameters. items: type: string maxItems: 25 minItems: 1 type: array destinationAddress: description: An array of address list names to be evaluated against the traffic destination address. items: type: string maxItems: 25 minItems: 1 type: array service: description: An array of service list names to be evaluated against the traffic protocol and protocol-specific parameters. items: type: string maxItems: 25 minItems: 1 type: array sourceAddress: description: An array of address list names to be evaluated against the traffic source address. items: type: string maxItems: 25 minItems: 1 type: array url: description: An array of URL pattern list names to be evaluated against the HTTP(S) request target. items: type: string maxItems: 25 minItems: 1 type: array type: object WorkRequestSummaryCollection: description: Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata. properties: items: description: List of workRequestSummary objects. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object ServiceList: description: 'A group of services. ' properties: description: description: The description of the service list. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name of the service Group. maxLength: 28 minLength: 2 type: string parentResourceId: description: OCID of the Network Firewall Policy this serviceList belongs to. maxLength: 255 minLength: 1 type: string services: description: List of services in the group. example: - - my-service-1 - my-tcp-service - my-web-service items: type: string maxItems: 1000 minItems: 0 type: array totalServices: description: Count of total services in the given service List. minimum: 0 type: integer required: - name - services - parentResourceId - totalServices type: object NatRuleCollection: description: Collection of NAT rule summaries in the network firewall policy. properties: items: description: Collection of Nat Rule Summaries. items: $ref: '#/components/schemas/NatRuleSummary' type: array required: - items type: object WorkRequestSummary: description: A summary of the status of a work request. properties: compartmentId: description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used ' type: string id: description: The id of the work request. type: string operationType: description: Type of the work request enum: - CREATE_NETWORK_FIREWALL - UPDATE_NETWORK_FIREWALL - DELETE_NETWORK_FIREWALL - MOVE_NETWORK_FIREWALL - CREATE_NETWORK_FIREWALL_POLICY - UPDATE_NETWORK_FIREWALL_POLICY - DELETE_NETWORK_FIREWALL_POLICY - MOVE_NETWORK_FIREWALL_POLICY type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - NEEDS_ATTENTION - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted DecryptionRule: description: 'Decryption Rule used in the firewall policy rules. A Decryption Rule is used to define which traffic should be decrypted by the firewall, and how it should do so. ' properties: action: description: 'Action: * NO_DECRYPT - Matching traffic is not decrypted. * DECRYPT - Matching traffic is decrypted with the specified `secret` according to the specified `decryptionProfile`. ' enum: - NO_DECRYPT - DECRYPT type: string condition: $ref: '#/components/schemas/DecryptionRuleMatchCriteria' decryptionProfile: description: The name of the decryption profile to use. type: string name: description: Name for the decryption rule, must be unique within the policy. format: x-obmcs-ascii-identifier maxLength: 63 minLength: 2 pattern: ^[a-zA-Z](-?[a-zA-Z_0-9])*$ type: string secret: description: The name of a mapped secret. Its `type` must match that of the specified decryption profile. type: string required: - name - condition - action type: object UpdateApplicationDetails: description: 'Request for updating an existing application in context to the network firewall policy. ' discriminator: propertyName: type properties: description: description: The description of the application. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string type: description: Describes the type of Application. enum: - ICMP - ICMP_V6 type: string x-obmcs-top-level-enum: '#/definitions/AppType' required: - type type: object UrlPattern: description: 'Pattern describing a URL or set of URLs. ' discriminator: propertyName: type properties: type: description: "The type of pattern.\n * SIMPLE - A simple pattern with optional subdomain and/or path suffix wildcards.\n" enum: - SIMPLE type: string required: - type type: object Service: description: 'A Service which can be used to identify the running service. It uses port & protocol information. ' discriminator: propertyName: type properties: description: description: The description of the service. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name of the service. maxLength: 28 minLength: 2 type: string parentResourceId: description: OCID of the Network Firewall Policy this service belongs to. maxLength: 255 minLength: 1 type: string type: description: Describes the type of Service. enum: - TCP_SERVICE - UDP_SERVICE type: string x-obmcs-top-level-enum: '#/definitions/ServiceType' required: - type - name - parentResourceId type: object CreateApplicationDetails: description: Request for creating a application against a policy. discriminator: propertyName: type properties: description: description: The description of the application. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name of the application maxLength: 28 minLength: 2 type: string type: description: Describes the type of Application. enum: - ICMP - ICMP_V6 type: string x-obmcs-top-level-enum: '#/definitions/AppType' required: - name type: object ServiceListSummaryCollection: description: Collection of Service Lists in the network firewall policy properties: items: description: List of service lists. items: $ref: '#/components/schemas/ServiceListSummary' type: array required: - items type: object UpdateNatRuleDetails: description: 'Request for updating a NAT rule used in the firewall policy. A [NAT rule](/iaas/Content/network-firewall/policies.htm#network-firewall-policies__nat) defines which traffic NAT should be applied to by the firewall, and how it should do so. ' discriminator: propertyName: type properties: description: description: Description of a NAT rule. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string position: $ref: '#/components/schemas/RulePosition' type: description: 'NAT type: * NATV4 - NATV4 type NAT. ' enum: - NATV4 type: string x-obmcs-top-level-enum: '#/definitions/NatType' required: - type type: object UrlListSummaryCollection: description: Collection of URL Lists in the network firewall policy properties: items: description: Collection of url lists. items: $ref: '#/components/schemas/UrlListSummary' type: array required: - items type: object SecurityRuleMatchCriteria: description: 'Criteria to evaluate against network traffic. A match occurs when at least one item in the array associated with each specified property corresponds with the relevant aspect of the traffic. ' properties: applications: description: An array of application list names to be evaluated against the traffic protocol and protocol-specific parameters. items: type: string maxItems: 25 minItems: 1 type: array destinations: description: An array of IP address list names to be evaluated against the traffic destination address. items: type: string maxItems: 25 minItems: 1 type: array sources: description: An array of IP address list names to be evaluated against the traffic source address. items: type: string maxItems: 25 minItems: 1 type: array urls: description: An array of URL pattern list names to be evaluated against the HTTP(S) request target. items: type: string maxItems: 25 minItems: 1 type: array type: object UpdateApplicationGroupDetails: description: 'Request for updating an existing application in context to the network firewall policy. ' properties: apps: description: Collection of application names. example: - - my-app-1 - my-tcp-app - my-web-app items: type: string maxItems: 500 type: array description: description: The description of the application list. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string type: object ApplicationSummaryCollection: description: Collection of Applications in the network firewall policy properties: items: description: Collection of Applications. items: $ref: '#/components/schemas/ApplicationSummary' type: array required: - items type: object NatRuleSummary: description: 'Summary of NAT rules used in the firewall policy. A [NAT rule](/iaas/Content/network-firewall/policies.htm#network-firewall-policies__nat) defines which traffic NAT should be applied to by the firewall, and how it should do so. ' discriminator: propertyName: type properties: description: description: Description of a NAT rule. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name for the NAT rule, must be unique within the policy. format: x-obmcs-ascii-identifier maxLength: 63 minLength: 2 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string parentResourceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Network Firewall Policy this NAT rule belongs to. ' maxLength: 255 minLength: 1 type: string priorityOrder: description: The priority order in which this rule should be evaluated. format: int64 type: integer type: description: 'NAT type: * NATV4 - NATV4 type NAT. ' enum: - NATV4 type: string x-obmcs-top-level-enum: '#/definitions/NatType' required: - name - type - priorityOrder - parentResourceId type: object CreateAddressListDetails: description: 'The Request for creating the address List ' properties: addresses: description: List of addresses. example: - 192.168.2.1 - 10.240.12.0/24 - 2001:db8:3333:4444:CCCC:DDDD:EEEE:FFFF - 2002::1234:abcd:ffff:c0a8:101/64 - myhostname.oraclevcn.com items: type: string maxItems: 1000 type: array description: description: The description of the address list. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Unique name to identify the group of addresses to be used in the policy rules. type: string type: description: Type of address List. The accepted values are - * FQDN * IP enum: - FQDN - IP type: string x-obmcs-top-level-enum: '#/definitions/AddressListType' required: - name - type - addresses type: object UpdateDecryptionProfileDetails: description: Update Request for Decryption Profile used on the firewall policy rules. discriminator: propertyName: type properties: description: description: The description of the decryption profile. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string type: description: Describes the type of Decryption Profile SslForwardProxy or SslInboundInspection. enum: - SSL_INBOUND_INSPECTION - SSL_FORWARD_PROXY type: string x-obmcs-top-level-enum: '#/definitions/InspectionType' required: - type type: object DecryptionProfile_2: description: Decryption Profile used on the firewall policy rules. discriminator: propertyName: type properties: description: description: The description of the decryption profile. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Unique Name of the decryption profile. maxLength: 28 minLength: 2 type: string parentResourceId: description: OCID of the Network Firewall Policy this decryption profile belongs to. maxLength: 255 minLength: 1 type: string type: description: Describes the type of Decryption Profile SslForwardProxy or SslInboundInspection. enum: - SSL_INBOUND_INSPECTION - SSL_FORWARD_PROXY type: string x-obmcs-top-level-enum: '#/definitions/InspectionType' required: - type - name - parentResourceId type: object DecryptionRule_2: description: 'Decryption Rule used in the firewall policy rules. A Decryption Rule is used to define which traffic should be decrypted by the firewall, and how it should do so. ' properties: action: description: 'Action: * NO_DECRYPT - Matching traffic is not decrypted. * DECRYPT - Matching traffic is decrypted with the specified `secret` according to the specified `decryptionProfile`. ' enum: - NO_DECRYPT - DECRYPT type: string x-obmcs-top-level-enum: '#/definitions/DecryptionActionType' condition: $ref: '#/components/schemas/DecryptionRuleMatchCriteria_2' decryptionProfile: description: The name of the decryption profile to use. type: string description: description: The description of the decryption rule. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name for the decryption rule, must be unique within the policy. format: x-obmcs-ascii-identifier maxLength: 63 minLength: 2 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string parentResourceId: description: OCID of the Network Firewall Policy this decryption rule belongs to. maxLength: 255 minLength: 1 type: string position: $ref: '#/components/schemas/RulePosition' secret: description: The name of a mapped secret. Its `type` must match that of the specified decryption profile. type: string secrets: description: An array of mapped secrets. items: type: string maxItems: 12 minItems: 1 type: array required: - name - condition - action - parentResourceId type: object DecryptionProfile: description: Decryption Profile used on the firewall policy rules. discriminator: propertyName: type properties: type: description: Describes the type of Decryption Profile SslForwardProxy or SslInboundInspection. enum: - SSL_INBOUND_INSPECTION - SSL_FORWARD_PROXY type: string required: - type type: object TunnelInspectionRuleSummaryCollection: description: Collection of Tunnel Inspection Rule Summaries in the network firewall policy properties: items: description: Collection of Tunnel Inspection Rule Summaries. items: $ref: '#/components/schemas/TunnelInspectionRuleSummary' type: array required: - items type: object CloneNetworkFirewallPolicyDetails: description: Request data required to clone a network firewall policy. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the NetworkFirewall Policy. maxLength: 255 minLength: 1 type: string x-default-description: If you do not supply this field, the service will generate a clone in the same compartment as the current Network Firewall Policy. definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the network firewall policy. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string displayName: description: A user-friendly optional name for the cloned firewall policy. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string x-default-description: If you do not supply this field, the service will generate a displayName for the Network Firewall Policy. freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object CreateServiceListDetails: description: Request for creating a service list in a policy. properties: description: description: The description of the service list. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name of the service Group. maxLength: 28 minLength: 2 type: string services: description: Collection of service names. example: - - my-service-1 - my-tcp-service - my-web-service items: type: string maxItems: 1000 minItems: 0 type: array required: - name - services type: object CreateTunnelInspectionRuleDetails: description: 'Request for creating Tunnel Inspection Rule used in the firewall policy rules. Tunnel Inspection Rule determines whether tunnel inspection is applied on the traffic based on attributes such as Tunnel Inspection protocol, the source and destination IP address. ' discriminator: propertyName: protocol properties: action: default: INSPECT_AND_CAPTURE_LOG description: "Types of Inspect Action on the traffic flow.\n\n * INSPECT - Inspect the traffic.\n * INSPECT_AND_CAPTURE_LOG - Inspect and capture logs for the traffic.\n" enum: - INSPECT - INSPECT_AND_CAPTURE_LOG type: string x-obmcs-top-level-enum: '#/definitions/InspectActionType' description: description: The description of the tunnel inspect rule. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name for the Tunnel Inspection Rule, must be unique within the policy. format: x-obmcs-ascii-identifier maxLength: 63 minLength: 2 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string position: $ref: '#/components/schemas/RulePosition' protocol: description: "Types of Tunnel Inspection Protocol to be applied on the traffic.\n\n * VXLAN - VXLAN Tunnel Inspection Protocol will be applied on the traffic.\n" enum: - VXLAN type: string x-obmcs-top-level-enum: '#/definitions/TunnelInspectionProtocol' required: - name - protocol type: object WorkRequestLogEntry: description: A log message from the execution of a work request. properties: message: description: Human-readable log message. type: string timestamp: description: The time the log message was written. An RFC3339 formatted datetime string format: date-time type: string required: - message - timestamp CreateDecryptionProfileDetails: description: Request for Decryption Profile used on the firewall policy rules. discriminator: propertyName: type properties: description: description: The description of the decryption profile. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name of the decryption profile. maxLength: 28 minLength: 2 type: string type: description: Describes the type of Decryption Profile SslForwardProxy or SslInboundInspection. enum: - SSL_INBOUND_INSPECTION - SSL_FORWARD_PROXY type: string x-obmcs-top-level-enum: '#/definitions/InspectionType' required: - type - name type: object TunnelInspectionRuleSummary: description: 'Summary for the Tunnel Inspection Rule used in the firewall policy rules. Tunnel Inspection Rule determines whether tunnel inspection is applied on the traffic based on attributes such as Tunnel Inspect protocol, the source and destination IP address. ' discriminator: propertyName: protocol properties: action: default: INSPECT_AND_CAPTURE_LOG description: "Types of Inspect Action on the Traffic flow.\n\n * INSPECT - Inspect the traffic.\n * INSPECT_AND_CAPTURE_LOG - Inspect and capture logs for the traffic.\n" enum: - INSPECT - INSPECT_AND_CAPTURE_LOG type: string x-obmcs-top-level-enum: '#/definitions/InspectActionType' description: description: The description of the tunnel inspect rule. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name for the Tunnel Inspection Rule, must be unique within the policy. format: x-obmcs-ascii-identifier maxLength: 63 minLength: 2 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string parentResourceId: description: OCID of the Network Firewall Policy this Tunnel Inspection Rule belongs to. maxLength: 255 minLength: 1 type: string priorityOrder: description: The priority order in which this rule should be evaluated format: int64 type: integer protocol: description: "Types of Tunnel Inspection Protocol to be applied on the traffic.\n\n * VXLAN - VXLAN Tunnel Inspection Protocol will be applied on the traffic.\n" enum: - VXLAN type: string x-obmcs-top-level-enum: '#/definitions/TunnelInspectionProtocol' required: - name - priorityOrder - protocol - parentResourceId type: object DecryptionRuleSummary: description: 'Summary for Decryption Rule used in the firewall policy rules. A Decryption Rule is used to define which traffic should be decrypted by the firewall, and how it should do so. ' properties: action: description: 'Action: * NO_DECRYPT - Matching traffic is not decrypted. * DECRYPT - Matching traffic is decrypted with the specified `secret` according to the specified `decryptionProfile`. ' enum: - NO_DECRYPT - DECRYPT type: string x-obmcs-top-level-enum: '#/definitions/DecryptionActionType' decryptionProfile: description: The name of the decryption profile to use. type: string description: description: The description of the decryption rule. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name for the decryption rule, must be unique within the policy. format: x-obmcs-ascii-identifier maxLength: 63 minLength: 2 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string parentResourceId: description: OCID of the Network Firewall Policy this application belongs to. maxLength: 255 minLength: 1 type: string priorityOrder: description: The priority order in which this rule should be evaluated. format: int64 type: integer secret: description: The name of a mapped secret. Its `type` must match that of the specified decryption profile. type: string required: - name - action - priorityOrder - secret - decryptionProfile - parentResourceId type: object WorkRequest: description: A description of workrequest status properties: compartmentId: description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used ' type: string id: description: The id of the work request. type: string operationType: description: Type of the work request enum: - CREATE_NETWORK_FIREWALL - UPDATE_NETWORK_FIREWALL - DELETE_NETWORK_FIREWALL - MOVE_NETWORK_FIREWALL - CREATE_NETWORK_FIREWALL_POLICY - UPDATE_NETWORK_FIREWALL_POLICY - DELETE_NETWORK_FIREWALL_POLICY - MOVE_NETWORK_FIREWALL_POLICY type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - NEEDS_ATTENTION - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted SecurityRuleSummary: description: 'Summary for the Security Rule used in the firewall policy rules. Security Rules determine whether to block or allow a session based on traffic attributes, such as the source and destination IP address, protocol/port, and the HTTP(S) target URL. ' properties: action: description: "Types of Action on the Traffic flow.\n\n * ALLOW - Allows the traffic.\n * DROP - Silently drops the traffic, e.g. without sending a TCP reset.\n * REJECT - Rejects the traffic, sending a TCP reset to client and/or server as applicable.\n * INSPECT - Inspects traffic for vulnerability as specified in `inspection`, which may result in rejection.\n" enum: - ALLOW - DROP - REJECT - INSPECT type: string x-obmcs-top-level-enum: '#/definitions/TrafficActionType' description: description: The description of the security rule. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string inspection: description: "Type of inspection to affect the Traffic flow. This is only applicable if action is INSPECT.\n\n * INTRUSION_DETECTION - Intrusion Detection.\n * INTRUSION_PREVENTION - Intrusion Detection and Prevention. Traffic classified as potentially malicious will be rejected as described in `type`.\n" enum: - INTRUSION_DETECTION - INTRUSION_PREVENTION type: string x-obmcs-top-level-enum: '#/definitions/TrafficInspectionType' name: description: Name for the Security rule, must be unique within the policy. format: x-obmcs-ascii-identifier maxLength: 63 minLength: 2 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string parentResourceId: description: OCID of the network firewall policy this security rule belongs to. maxLength: 255 minLength: 1 type: string priorityOrder: description: The priority order in which this rule should be evaluated. format: int64 type: integer required: - name - priorityOrder - action - parentResourceId type: object NatConfigurationResponse: description: 'Response to a request to configure Network Address Translation (NAT) on a firewall. To perform NAT on traffic passing the private NAT IPs to the firewall, the attached network firewall policy must also have NAT rules and NAT configuration must be enabled. If NAT configuration is enabled and the attached firewall policy does not contain NAT rule then NAT IPs will get allocated but NAT will not be performed on any traffic. ' properties: mustEnablePrivateNat: description: 'True indicates that NAT configuration is enabled. False indicates NAT configuration is disabled. ' type: boolean natIpAddressList: description: 'An array of Private NAT IP addresses that are associated with the Network Firewall. These IP addresses are reserved for NAT and shouldn''t be used for any other purpose in the subnet. This list contains IP addresses when NAT configuration is enabled. This list is empty or null IP when NAT configuration is disabled. ' items: type: string maxItems: 31 type: array type: object NetworkFirewallHealthStatus: description: 'Response for network firewall health status. ' properties: status: description: 'Overall health status of Network firewall ' enum: - CRITICAL - WARNING - OK - UNKNOWN type: string x-obmcs-top-level-enum: '#/definitions/HealthStatus' required: - status type: object UrlListSummary: description: URL List Summary in the network firewall policy properties: description: description: The description of the Url list. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name of URL List maxLength: 28 minLength: 2 type: string parentResourceId: description: OCID of the Network Firewall Policy this mapped secret belongs to. maxLength: 255 minLength: 1 type: string totalUrls: description: Total count of URLs in the URL List minimum: 0 type: integer required: - name - totalUrls - parentResourceId type: object DecryptionRuleSummaryCollection: description: Collection of Decryption Rule Summaries in the network firewall policy properties: items: description: Collection of Decryption Rule Summaries. items: $ref: '#/components/schemas/DecryptionRuleSummary' type: array required: - items type: object UpdateAddressListDetails: description: The request details to be updated in the address List for the policy. discriminator: propertyName: type properties: description: description: The description of the address list. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string type: description: Type of address List. The accepted values are - * FQDN * IP enum: - FQDN - IP type: string x-obmcs-top-level-enum: '#/definitions/AddressListType' required: - type type: object NetworkFirewallCollection: description: A collection of NetworkFirewallSummary items. properties: items: description: List of network firewalls. items: $ref: '#/components/schemas/NetworkFirewallSummary' type: array required: - items type: object UpdateServiceDetails: description: 'Request for updating an existing service in context to the network firewall policy. ' discriminator: propertyName: type properties: description: description: The description of the service. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string type: description: Describes the type of Service. enum: - TCP_SERVICE - UDP_SERVICE type: string x-obmcs-top-level-enum: '#/definitions/ServiceType' required: - type type: object CreateNatRuleDetails: description: 'Request for creating a NAT rule used in the firewall policy. A [NAT rule](/iaas/Content/network-firewall/policies.htm#network-firewall-policies__nat) defines which traffic NAT should be applied to by the firewall. ' discriminator: propertyName: type properties: description: description: Description of a NAT rule. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name for the NAT rule, must be unique within the policy. format: x-obmcs-ascii-identifier maxLength: 63 minLength: 2 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string position: $ref: '#/components/schemas/RulePosition' type: description: 'NAT type: * NATV4 - NATV4 type NAT. ' enum: - NATV4 type: string x-obmcs-top-level-enum: '#/definitions/NatType' required: - name - type type: object ServiceSummaryCollection: description: Collection of Services in the network firewall policy properties: items: description: Collection of Services. items: $ref: '#/components/schemas/ServiceSummary' type: array required: - items type: object CreateServiceDetails: description: Request for creating a service against a policy. discriminator: propertyName: type properties: description: description: The description of the service. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name of the service maxLength: 28 minLength: 2 type: string type: description: Describes the type of Service. enum: - TCP_SERVICE - UDP_SERVICE type: string x-obmcs-top-level-enum: '#/definitions/ServiceType' required: - name type: object x-abstract: true AddressList: description: 'List of addresses with a reference name. The value of an entry is a list of IP addresses or prefixes in CIDR notation or FQDNs. The associated key is the identifier by which the IP address list is referenced. ' properties: addresses: description: List of addresses. example: - 192.168.2.1 - 10.240.12.0/24 - 2001:db8:3333:4444:CCCC:DDDD:EEEE:FFFF - 2002::1234:abcd:ffff:c0a8:101/64 - myhostname.oraclevcn.com items: type: string maxItems: 1000 type: array description: description: The description of the address list. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Unique name to identify the group of addresses to be used in the policy rules. maxLength: 28 minLength: 2 type: string parentResourceId: description: OCID of the Network Firewall Policy this Address List belongs to. maxLength: 255 minLength: 1 type: string totalAddresses: description: Count of total Addresses in the AddressList maximum: 65535 minimum: 0 type: integer type: description: Type of address List. The accepted values are - * FQDN * IP enum: - FQDN - IP type: string x-obmcs-top-level-enum: '#/definitions/AddressListType' required: - name - addresses - type - totalAddresses - parentResourceId type: object UpdateSecurityRuleDetails: description: 'Update Request for Security Rule used in the firewall policy rules. Security Rules determine whether to block or allow a session based on traffic attributes, such as the source and destination IP address, protocol/port, and the HTTP(S) target URL. ' properties: action: description: "Types of Action on the Traffic flow.\n\n * ALLOW - Allows the traffic.\n * DROP - Silently drops the traffic, e.g. without sending a TCP reset.\n * REJECT - Rejects the traffic, sending a TCP reset to client and/or server as applicable.\n * INSPECT - Inspects traffic for vulnerability as specified in `inspection`, which may result in rejection.\n" enum: - ALLOW - DROP - REJECT - INSPECT type: string x-obmcs-top-level-enum: '#/definitions/TrafficActionType' condition: $ref: '#/components/schemas/SecurityRuleMatchCriteria_2' description: description: The description of the security rule. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string inspection: description: "Type of inspection to affect the Traffic flow. This is only applicable if action is INSPECT.\n\n * INTRUSION_DETECTION - Intrusion Detection.\n * INTRUSION_PREVENTION - Intrusion Detection and Prevention. Traffic classified as potentially malicious will be rejected as described in `type`.\n" enum: - INTRUSION_DETECTION - INTRUSION_PREVENTION type: string x-obmcs-top-level-enum: '#/definitions/TrafficInspectionType' position: $ref: '#/components/schemas/RulePosition' required: - condition - action type: object CreateMappedSecretDetails: description: 'The Request for creating the Mapped Secret ' discriminator: propertyName: source properties: description: description: The description of the mapped secret. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Unique name to identify the group of urls to be used in the policy rules. maxLength: 58 minLength: 6 type: string source: description: Source of the secrets, where the secrets are stored. type: string type: default: SSL_INBOUND_INSPECTION description: 'Type of the secrets mapped based on the policy. * `SSL_INBOUND_INSPECTION`: For Inbound inspection of SSL traffic. * `SSL_FORWARD_PROXY`: For forward proxy certificates for SSL inspection. ' enum: - SSL_INBOUND_INSPECTION - SSL_FORWARD_PROXY type: string x-obmcs-top-level-enum: '#/definitions/InspectionType' required: - name - source - type type: object AddressListSummaryCollection: description: Collection of Address Lists in the network firewall policy properties: items: description: Collection of address lists. items: $ref: '#/components/schemas/AddressListSummary' type: array required: - items type: object WorkRequestResource: description: A resource created or operated on by a work request. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type the work request affects. type: string entityUri: description: The URI path that the user can do a GET on to access the resource metadata type: string identifier: description: The identifier of the resource the work request affects. type: string metadata: additionalProperties: type: string description: Additional information that helps to explain the resource. enum: - IS_DRY_RUN type: object x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey' required: - actionType - entityType - identifier ChangeNetworkFirewallCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the Network Firewalll resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object NetworkFirewall: description: 'A network firewall is a security resource that exists in a subnet of your choice and controls incoming and outgoing network traffic based on a set of security rules. Each firewall is associated with a policy. Traffic is routed to and from the firewall from resources such as internet gateways and dynamic routing gateways (DRGs). For more information, see [Overview of Network Firewall](/iaas/Content/network-firewall/overview.htm) ' properties: availabilityDomain: description: 'Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use the [ListAvailabilityDomains](#/en/identity/20160918/AvailabilityDomain/ListAvailabilityDomains) operation. Example: `kIdk:PHX-AD-1` ' type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the Network Firewall. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Network Firewall resource. type: string ipv4Address: description: IPv4 address for the Network Firewall. type: string x-default-description: If you do not supply this field, the service will assign one from the subnet CIDR range. ipv6Address: description: IPv6 address for the Network Firewall. type: string x-default-description: 'null' lifecycleDetails: description: A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'FAILED' state. type: string lifecycleState: description: The current state of the Network Firewall. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' natConfiguration: $ref: '#/components/schemas/NatConfigurationResponse' networkFirewallPolicyId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Network Firewall Policy. type: string networkSecurityGroupIds: description: An array of network security groups [OCID](/iaas/Content/General/Concepts/identifiers.htm) associated with the Network Firewall. items: type: string maxItems: 5 type: array securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: {"MaxEgressCount": {"value": "42", "mode": "enforce"}} ' type: object description: '[Security attributes](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing (ZPR)](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/overview.htm) policy to control access to ZPR-supported resources. ' type: object shape: description: The shape of a firewall to determine the bandwidth that the firewall allows. maxLength: 50 type: string subnetId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the Network Firewall. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The time at which the Network Firewall was created in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The time at which the Network Firewall was updated in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - timeUpdated - networkFirewallPolicyId - subnetId - displayName - freeformTags - definedTags type: object UpdateServiceListDetails: description: 'Request for updating an existing service in context to the network firewall policy. ' properties: description: description: The description of the service list. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string services: description: Collection of service names. example: - - my-service-1 - my-tcp-service - my-web-service items: type: string maxItems: 1000 minItems: 0 type: array required: - services type: object UpdateNetworkFirewallDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object natConfiguration: $ref: '#/components/schemas/NatConfigurationRequest' networkFirewallPolicyId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Network Firewall Policy. maxLength: 255 minLength: 1 type: string networkSecurityGroupIds: description: An array of network security groups [OCID](/iaas/Content/General/Concepts/identifiers.htm) associated with the Network Firewall. items: type: string maxItems: 5 type: array securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: {"MaxEgressCount": {"value": "42", "mode": "enforce"}} ' type: object description: '[Security attributes](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing (ZPR)](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/overview.htm) policy to control access to ZPR-supported resources. ' type: object shape: description: The shape of a firewall to determine the bandwidth that the firewall allows. maxLength: 50 type: string type: object WorkRequestError: description: An error encountered while executing a work request. properties: code: description: 'A machine-usable code for the error that occured. Error codes are listed on (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) ' type: string message: description: A human readable description of the issue encountered. type: string timestamp: description: The time the error occured. An RFC3339 formatted datetime string. format: date-time type: string required: - code - message - timestamp CreateDecryptionRuleDetails: description: 'Request for creating Decryption Rule used in the firewall policy rules. A Decryption Rule is used to define which traffic should be decrypted by the firewall, and how it should do so. ' properties: action: description: 'Action: * NO_DECRYPT - Matching traffic is not decrypted. * DECRYPT - Matching traffic is decrypted with the specified `secret` according to the specified `decryptionProfile`. ' enum: - NO_DECRYPT - DECRYPT type: string x-obmcs-top-level-enum: '#/definitions/DecryptionActionType' condition: $ref: '#/components/schemas/DecryptionRuleMatchCriteria_2' decryptionProfile: description: The name of the decryption profile to use. type: string description: description: The description of the decryption rule. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name for the decryption rule, must be unique within the policy. format: x-obmcs-ascii-identifier maxLength: 63 minLength: 2 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string position: $ref: '#/components/schemas/RulePosition' secret: description: The name of a mapped secret. Its `type` must match that of the specified decryption profile. type: string secrets: description: An array of mapped secrets. items: type: string maxItems: 12 minItems: 1 type: array required: - name - condition - action type: object TunnelInspectionRule: description: 'Tunnel Inspection Rule used in the firewall policy rules. Tunnel Inspection Rule determines whether tunnel inspection is applied on the traffic based on attributes such as Tunnel Inspect protocol, the source and destination IP addresses. ' discriminator: propertyName: protocol properties: action: default: INSPECT_AND_CAPTURE_LOG description: "Types of Inspect Action on the Traffic flow.\n\n * INSPECT - Inspect the traffic.\n * INSPECT_AND_CAPTURE_LOG - Inspect and capture logs for the traffic.\n" enum: - INSPECT - INSPECT_AND_CAPTURE_LOG type: string x-obmcs-top-level-enum: '#/definitions/InspectActionType' description: description: The description of the tunnel inspect rule. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name for the Tunnel Inspection Rule, must be unique within the policy. format: x-obmcs-ascii-identifier maxLength: 63 minLength: 2 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string parentResourceId: description: OCID of the Network Firewall Policy this Tunnel Inspection Rule belongs to. maxLength: 255 minLength: 1 type: string position: $ref: '#/components/schemas/RulePosition' priorityOrder: description: The priority order in which this rule should be evaluated format: int64 minimum: 0 type: integer protocol: description: "Types of Tunnel Inspection Protocol to be applied on the traffic.\n\n * VXLAN - VXLAN Tunnel Inspection Protocol will be applied on the traffic.\n" enum: - VXLAN type: string x-obmcs-top-level-enum: '#/definitions/TunnelInspectionProtocol' required: - name - protocol - parentResourceId type: object MappedSecret_2: description: Mapped secret used on the firewall policy rules. discriminator: propertyName: source properties: description: description: The description of the mapped secret. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name of the secret. maxLength: 58 minLength: 6 type: string parentResourceId: description: OCID of the Network Firewall Policy this Mapped Secret belongs to. maxLength: 255 minLength: 1 type: string source: description: Source of the secrets, where the secrets are stored. enum: - OCI_VAULT type: string x-obmcs-top-level-enum: '#/definitions/MappedSecretType' type: default: SSL_INBOUND_INSPECTION description: "Type of the secrets mapped based on the policy.\n\n * `SSL_INBOUND_INSPECTION`: For Inbound inspection of SSL traffic.\n * `SSL_FORWARD_PROXY`: For forward proxy certificates for SSL inspection.\n" enum: - SSL_INBOUND_INSPECTION - SSL_FORWARD_PROXY type: string x-obmcs-top-level-enum: '#/definitions/InspectionType' required: - source - type - name - parentResourceId type: object NetworkFirewallPolicySummary: description: Summary of the NetworkFirewall Policy. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the NetworkFirewall Policy. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly optional name for the firewall policy. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource - Network Firewall Policy. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current lifecycle state of the Network Firewall Policy. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The time instant at which the Network Firewall Policy was created in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The time instant at which the Network Firewall Policy was updated in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - freeformTags - definedTags type: object UpdateTunnelInspectionRuleDetails: description: 'Update Request for creating Tunnel Inspection Rule used in the firewall policy rules. Tunnel Inspection Rule determines whether tunnel inspection is applied on the traffic based on attributes such as Tunnel Inspect protocol, the source and destination IP address. ' discriminator: propertyName: protocol properties: action: default: INSPECT_AND_CAPTURE_LOG description: "Types of Inspect Action on the Traffic flow.\n\n * INSPECT - Inspect the traffic.\n * INSPECT_AND_CAPTURE_LOG - Inspect and capture logs for the traffic.\n" enum: - INSPECT - INSPECT_AND_CAPTURE_LOG type: string x-obmcs-top-level-enum: '#/definitions/InspectActionType' description: description: The description of the tunnel inspect rule. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string position: $ref: '#/components/schemas/RulePosition' protocol: description: "Types of Tunnel Inspection Protocol to be applied on the traffic.\n\n * VXLAN - VXLAN Tunnel Inspection Protocol will be applied on the traffic.\n" enum: - VXLAN type: string x-obmcs-top-level-enum: '#/definitions/TunnelInspectionProtocol' required: - protocol type: object UpdateDecryptionRuleDetails: description: 'Request for updating Decryption Rule used in the firewall policy rules. A Decryption Rule is used to define which traffic should be decrypted by the firewall, and how it should do so. ' properties: action: description: 'Action: * NO_DECRYPT - Matching traffic is not decrypted. * DECRYPT - Matching traffic is decrypted with the specified `secret` according to the specified `decryptionProfile`. ' enum: - NO_DECRYPT - DECRYPT type: string x-obmcs-top-level-enum: '#/definitions/DecryptionActionType' condition: $ref: '#/components/schemas/DecryptionRuleMatchCriteria_2' decryptionProfile: description: The name of the decryption profile to use. type: string description: description: The description of the decryption rule. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string position: $ref: '#/components/schemas/RulePosition' secret: description: The name of a mapped secret. Its `type` must match that of the specified decryption profile. type: string secrets: description: An array of mapped secrets. items: type: string maxItems: 12 minItems: 1 type: array required: - condition - action type: object CreateSecurityRuleDetails: description: 'Reqeust for creating Security Rule used in the firewall policy rules. Security Rules determine whether to block or allow a session based on traffic attributes, such as the source and destination IP address, protocol/port, and the HTTP(S) target URL. ' properties: action: description: "Types of Action on the Traffic flow.\n\n * ALLOW - Allows the traffic.\n * DROP - Silently drops the traffic, e.g. without sending a TCP reset.\n * REJECT - Rejects the traffic, sending a TCP reset to client and/or server as applicable.\n * INSPECT - Inspects traffic for vulnerability as specified in `inspection`, which may result in rejection.\n" enum: - ALLOW - DROP - REJECT - INSPECT type: string x-obmcs-top-level-enum: '#/definitions/TrafficActionType' condition: $ref: '#/components/schemas/SecurityRuleMatchCriteria_2' description: description: The description of the security rule. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string inspection: description: "Type of inspection to affect the Traffic flow. This is only applicable if action is INSPECT.\n\n * INTRUSION_DETECTION - Intrusion Detection.\n * INTRUSION_PREVENTION - Intrusion Detection and Prevention. Traffic classified as potentially malicious will be rejected as described in `type`.\n" enum: - INTRUSION_DETECTION - INTRUSION_PREVENTION type: string x-obmcs-top-level-enum: '#/definitions/TrafficInspectionType' name: description: Name for the Security rule, must be unique within the policy. format: x-obmcs-ascii-identifier maxLength: 63 minLength: 2 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string position: $ref: '#/components/schemas/RulePosition' required: - name - condition - action type: object ServiceListSummary: description: Summary object for service list in the network firewall policy. properties: description: description: The description of the service list. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name of the service groups. maxLength: 28 minLength: 2 type: string parentResourceId: description: OCID of the Network Firewall Policy this application belongs to. maxLength: 255 minLength: 1 type: string totalServices: description: Count of total services in the given service List. minimum: 0 type: integer required: - name - parentResourceId - totalServices type: object ChangeNetworkFirewallPolicyCompartmentDetails: description: The request details required to move the resource to target compartment. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object NatRule: description: 'A [NAT rule](/iaas/Content/network-firewall/policies.htm#network-firewall-policies__nat) defines which traffic NAT should be applied to by the firewall. ' discriminator: propertyName: type properties: description: description: Description of a NAT rule. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name for the NAT rule, must be unique within the policy. format: x-obmcs-ascii-identifier maxLength: 63 minLength: 2 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string parentResourceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Network Firewall policy this NAT rule belongs to. ' maxLength: 255 minLength: 1 type: string position: $ref: '#/components/schemas/RulePosition' priorityOrder: description: The priority order in which this rule should be evaluated format: int64 minimum: 0 type: integer type: description: 'NAT type: * NATV4 - NATV4 type NAT. ' enum: - NATV4 type: string x-obmcs-top-level-enum: '#/definitions/NatType' required: - name - type - parentResourceId type: object MappedSecretSummaryCollection: description: Collection of Mapped Secrets in the network firewall policy properties: items: description: Collection of Mapped Secrets. items: $ref: '#/components/schemas/MappedSecretSummary' type: array required: - items type: object UpdateMappedSecretDetails: description: The request details to be updated in the Mapped Secret for the policy. discriminator: propertyName: source properties: description: description: The description of the mapped secret. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string source: description: Source of the secrets, where the secrets are stored. type: string type: default: SSL_INBOUND_INSPECTION description: "Type of the secrets mapped based on the policy.\n\n * `SSL_INBOUND_INSPECTION`: For Inbound inspection of SSL traffic.\n * `SSL_FORWARD_PROXY`: For forward proxy certificates for SSL inspection.\n" enum: - SSL_INBOUND_INSPECTION - SSL_FORWARD_PROXY type: string x-obmcs-top-level-enum: '#/definitions/InspectionType' required: - type - source type: object NetworkFirewallPolicySummaryCollection: description: Collection of Network Firewall Policies. properties: items: description: Collection of network Firewall Policies. items: $ref: '#/components/schemas/NetworkFirewallPolicySummary' type: array required: - items type: object NetworkFirewallPolicy: description: Description of NetworkFirewall Policy. properties: applicationLists: additionalProperties: items: $ref: '#/components/schemas/Application' maxItems: 25 type: array description: 'Map defining application lists of the policy. The value of an entry is a list of "applications", each consisting of a protocol identifier (such as TCP, UDP, or ICMP) and protocol-specific parameters (such as a port range). The associated key is the identifier by which the application list is referenced. ' maxProperties: 25 type: object compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the NetworkFirewall Policy. type: string decryptionProfiles: additionalProperties: $ref: '#/components/schemas/DecryptionProfile' description: 'Map defining decryption profiles of the policy. The value of an entry is a decryption profile. The associated key is the identifier by which the decryption profile is referenced. ' maxProperties: 25 type: object decryptionRules: description: 'List of Decryption Rules defining the behavior of the policy. The first rule with a matching condition determines the action taken upon network traffic. ' items: $ref: '#/components/schemas/DecryptionRule' maxItems: 50 type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly optional name for the firewall policy. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource - Network Firewall Policy. type: string ipAddressLists: additionalProperties: example: - 192.168.2.1 - 10.240.12.0/24 - 2001:db8:3333:4444:CCCC:DDDD:EEEE:FFFF - 2002::1234:abcd:ffff:c0a8:101/64 items: type: string maxItems: 25 type: array description: 'Map defining IP address lists of the policy. The value of an entry is a list of IP addresses or prefixes in CIDR notation. ' maxProperties: 25 type: object isFirewallAttached: description: 'To determine if any Network Firewall is associated with this Network Firewall Policy. ' type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Network Firewall Policy. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' mappedSecrets: additionalProperties: $ref: '#/components/schemas/MappedSecret' description: 'Map defining secrets of the policy. The value of an entry is a "mapped secret" consisting of a purpose and source. The associated key is the identifier by which the mapped secret is referenced. ' maxProperties: 25 type: object securityRules: description: 'List of Security Rules defining the behavior of the policy. The first rule with a matching condition determines the action taken upon network traffic. ' items: $ref: '#/components/schemas/SecurityRule' maxItems: 50 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The time instant at which the Network Firewall Policy was created in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The time instant at which the Network Firewall Policy was updated in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string urlLists: additionalProperties: items: $ref: '#/components/schemas/UrlPattern' maxItems: 25 type: array description: 'Map defining URL pattern lists of the policy. The value of an entry is a list of URL patterns. The associated key is the identifier by which the URL pattern list is referenced. ' maxProperties: 25 type: object required: - id - compartmentId - lifecycleState - timeCreated - timeUpdated - displayName - freeformTags - definedTags - isFirewallAttached type: object UrlList: description: 'URL pattern lists of the policy. The value of an entry is a list of URL patterns. The associated key/name is the identifier by which the URL pattern list is referenced. ' properties: description: description: The description of the Url list. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Unique name identifier for the URL list. maxLength: 28 minLength: 2 type: string parentResourceId: description: OCID of the Network Firewall Policy this URL List belongs to. maxLength: 255 minLength: 1 type: string totalUrls: description: Total count of URLs in the URL List minimum: 0 type: integer urls: description: List of urls. items: $ref: '#/components/schemas/UrlPattern' maxItems: 1000 minItems: 0 type: array required: - name - urls - totalUrls - parentResourceId type: object DecryptionProfileSummary: description: Decryption Profile used on the firewall policy rules. properties: description: description: The description of the decryption profile. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name of the secret. maxLength: 28 minLength: 2 type: string parentResourceId: description: OCID of the Network Firewall Policy this decryption profile belongs to. maxLength: 255 minLength: 1 type: string type: default: SSL_INBOUND_INSPECTION description: "Type of the secrets mapped based on the policy.\n\n * `SSL_INBOUND_INSPECTION`: For Inbound inspection of SSL traffic.\n * `SSL_FORWARD_PROXY`: For forward proxy certificates for SSL inspection.\n" enum: - SSL_INBOUND_INSPECTION - SSL_FORWARD_PROXY type: string x-obmcs-top-level-enum: '#/definitions/InspectionType' required: - name - type - parentResourceId type: object UpdateUrlListDetails: description: The request details to be updated in the URL List for the policy. properties: description: description: The description of the Url list. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string urls: description: List of urls. items: $ref: '#/components/schemas/UrlPattern' maxItems: 1000 minItems: 0 type: array required: - urls type: object DecryptionProfileSummaryCollection: description: Collection of Decryption Profiles in the network firewall policy properties: items: description: Collection of Decryption Profiles. items: $ref: '#/components/schemas/DecryptionProfileSummary' type: array required: - items type: object ServiceSummary: description: Summary object for service element in the network firewall policy. properties: description: description: The description of the service. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name of the service. maxLength: 28 minLength: 2 type: string parentResourceId: description: OCID of the Network Firewall Policy this Service belongs to. maxLength: 255 minLength: 1 type: string type: description: Describes the type of Service. enum: - TCP_SERVICE - UDP_SERVICE type: string x-obmcs-top-level-enum: '#/definitions/ServiceType' required: - type - name - parentResourceId type: object ApplicationGroup: description: 'A group of applications. ' properties: apps: description: List of apps in the group. example: - - my-app-1 - my-tcp-app - my-web-app items: type: string maxItems: 1000 type: array description: description: The description of the application list. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name of the application Group. maxLength: 28 minLength: 2 type: string parentResourceId: description: OCID of the Network Firewall Policy this application group belongs to. maxLength: 255 minLength: 1 type: string totalApps: description: Count of total applications in the given application group. minimum: 0 type: integer required: - name - totalApps - parentResourceId type: object Application_2: description: 'A protocol identifier (such as TCP, UDP, or ICMP) and protocol-specific parameters (such as a port range). ' discriminator: propertyName: type properties: description: description: The description of the application. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name of the application. maxLength: 32 minLength: 2 type: string parentResourceId: description: OCID of the Network Firewall Policy this application belongs to. maxLength: 255 minLength: 1 type: string type: description: Describes the type of Application. enum: - ICMP - ICMP_V6 type: string x-obmcs-top-level-enum: '#/definitions/AppType' required: - type - name - parentResourceId type: object CreateUrlListDetails: description: 'The Request for creating the URL List ' properties: description: description: The description of the Url list. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Unique name to identify the group of urls to be used in the policy rules. maxLength: 28 minLength: 2 type: string urls: description: List of urls. items: $ref: '#/components/schemas/UrlPattern' maxItems: 1000 minItems: 0 type: array required: - name - urls type: object WorkRequestErrorCollection: description: Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata. properties: items: description: List of workRequestError objects. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object ApplicationGroupSummary: description: Summary object for application list in the network firewall policy. properties: description: description: The description of the application list. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name of the application groups. maxLength: 28 minLength: 2 type: string parentResourceId: description: OCID of the Network Firewall Policy this application group belongs to. maxLength: 255 minLength: 1 type: string totalApps: description: Count of total applications in the given application group. minimum: 0 type: integer required: - name - totalApps - parentResourceId type: object ApplicationGroupSummaryCollection: description: Collection of Application Lists in the network firewall policy properties: items: description: List of application lists. items: $ref: '#/components/schemas/ApplicationGroupSummary' type: array required: - items type: object CreateNetworkFirewallPolicyDetails: description: Request data required to create a network firewall policy. properties: applicationLists: additionalProperties: items: $ref: '#/components/schemas/Application' maxItems: 25 type: array description: 'Map defining application lists of the policy. The value of an entry is a list of "applications", each consisting of a protocol identifier (such as TCP, UDP, or ICMP) and protocol-specific parameters (such as a port range). The associated key is the identifier by which the application list is referenced. ' maxProperties: 25 type: object compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the NetworkFirewall Policy. maxLength: 255 minLength: 1 type: string decryptionProfiles: additionalProperties: $ref: '#/components/schemas/DecryptionProfile' description: 'Map defining decryption profiles of the policy. The value of an entry is a decryption profile. The associated key is the identifier by which the decryption profile is referenced. ' maxProperties: 25 type: object decryptionRules: description: 'List of Decryption Rules defining the behavior of the policy. The first rule with a matching condition determines the action taken upon network traffic. ' items: $ref: '#/components/schemas/DecryptionRule' maxItems: 50 type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly optional name for the firewall policy. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string x-default-description: If you do not supply this field, the service will generate a displayName for the Network Firewall Policy. freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ipAddressLists: additionalProperties: example: - 192.168.2.1 - 10.240.12.0/24 - 2001:db8:3333:4444:CCCC:DDDD:EEEE:FFFF - 2002::1234:abcd:ffff:c0a8:101/64 items: type: string maxItems: 25 type: array description: 'Map defining IP address lists of the policy. The value of an entry is a list of IP addresses or prefixes in CIDR notation. ' maxProperties: 25 type: object mappedSecrets: additionalProperties: $ref: '#/components/schemas/MappedSecret' description: 'Map defining secrets of the policy. The value of an entry is a "mapped secret" consisting of a purpose and source. The associated key is the identifier by which the mapped secret is referenced. ' maxProperties: 25 type: object securityRules: description: 'List of Security Rules defining the behavior of the policy. The first rule with a matching condition determines the action taken upon network traffic. ' items: $ref: '#/components/schemas/SecurityRule' maxItems: 50 type: array urlLists: additionalProperties: items: $ref: '#/components/schemas/UrlPattern' maxItems: 25 type: array description: 'Map defining URL pattern lists of the policy. The value of an entry is a list of URL patterns. The associated key is the identifier by which the URL pattern list is referenced. ' maxProperties: 25 type: object required: - compartmentId type: object UpdateNetworkFirewallPolicyDetails: description: The request details to be updated in the firewall policy. properties: applicationLists: additionalProperties: items: $ref: '#/components/schemas/Application' maxItems: 25 type: array description: 'Map defining application lists of the policy. The value of an entry is a list of "applications", each consisting of a protocol identifier (such as TCP, UDP, or ICMP) and protocol-specific parameters (such as a port range). The associated key is the identifier by which the application list is referenced. ' maxProperties: 25 type: object decryptionProfiles: additionalProperties: $ref: '#/components/schemas/DecryptionProfile' description: 'Map defining decryption profiles of the policy. The value of an entry is a decryption profile. The associated key is the identifier by which the decryption profile is referenced. ' maxProperties: 25 type: object decryptionRules: description: 'List of Decryption Rules defining the behavior of the policy. The first rule with a matching condition determines the action taken upon network traffic. ' items: $ref: '#/components/schemas/DecryptionRule' maxItems: 50 type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly name for the firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ipAddressLists: additionalProperties: example: - 192.168.2.1 - 10.240.12.0/24 - 2001:db8:3333:4444:CCCC:DDDD:EEEE:FFFF - 2002::1234:abcd:ffff:c0a8:101/64 items: type: string maxItems: 25 type: array description: 'Map defining IP address lists of the policy. The value of an entry is a list of IP addresses or prefixes in CIDR notation. The associated key is the identifier by which the IP address list is referenced. ' maxProperties: 25 type: object mappedSecrets: additionalProperties: $ref: '#/components/schemas/MappedSecret' description: 'Map defining secrets of the policy. The value of an entry is a "mapped secret" consisting of a purpose and source. The associated key is the identifier by which the mapped secret is referenced. ' maxProperties: 25 type: object securityRules: description: 'List of Security Rules defining the behavior of the policy. The first rule with a matching condition determines the action taken upon network traffic. ' items: $ref: '#/components/schemas/SecurityRule' maxItems: 50 type: array urlLists: additionalProperties: items: $ref: '#/components/schemas/UrlPattern' maxItems: 25 type: array description: 'Map defining URL pattern lists of the policy. The value of an entry is a list of URL patterns. The associated key is the identifier by which the URL pattern list is referenced. ' maxProperties: 25 type: object type: object SecurityRule_2: description: 'Security Rule used in the firewall policy rules. Security Rules determine whether to block or allow a session based on traffic attributes, such as the source and destination IP address, protocol/port, and the HTTP(S) target URL. ' properties: action: description: "Types of Action on the Traffic flow.\n\n * ALLOW - Allows the traffic.\n * DROP - Silently drops the traffic, e.g. without sending a TCP reset.\n * REJECT - Rejects the traffic, sending a TCP reset to client and/or server as applicable.\n * INSPECT - Inspects traffic for vulnerability as specified in `inspection`, which may result in rejection.\n" enum: - ALLOW - DROP - REJECT - INSPECT type: string x-obmcs-top-level-enum: '#/definitions/TrafficActionType' condition: $ref: '#/components/schemas/SecurityRuleMatchCriteria_2' description: description: The description of the security rule. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string inspection: description: "Type of inspection to affect the Traffic flow. This is only applicable if action is INSPECT.\n\n * INTRUSION_DETECTION - Intrusion Detection.\n * INTRUSION_PREVENTION - Intrusion Detection and Prevention. Traffic classified as potentially malicious will be rejected as described in `type`.\n" enum: - INTRUSION_DETECTION - INTRUSION_PREVENTION type: string x-obmcs-top-level-enum: '#/definitions/TrafficInspectionType' name: description: Name for the Security rule, must be unique within the policy. format: x-obmcs-ascii-identifier maxLength: 63 minLength: 2 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string parentResourceId: description: OCID of the Network Firewall Policy this security rule belongs to. maxLength: 255 minLength: 1 type: string position: $ref: '#/components/schemas/RulePosition' required: - name - condition - action - parentResourceId type: object RulePosition: description: An object which defines the position of the rule. properties: afterRule: description: Identifier for rule after which this rule lies. type: string beforeRule: description: Identifier for rule before which this rule lies. type: string type: object NetworkFirewallSummary: description: Summary of the Network Firewall. properties: availabilityDomain: description: 'Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use [ListAvailabilityDomains](#/en/identity/20160918/AvailabilityDomain/ListAvailabilityDomains) operation. Example: `kIdk:PHX-AD-1` ' type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the Network Firewall. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Network Firewall resource. type: string ipv4Address: description: IPv4 address for the Network Firewall. type: string x-default-description: If you do not supply this field, the service will assign one from the subnet cidr range. ipv6Address: description: IPv6 address for the Network Firewall. type: string x-default-description: 'null' lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Network Firewall. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' natConfiguration: $ref: '#/components/schemas/NatConfigurationResponse' networkFirewallPolicyId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Network Firewall Policy. type: string securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: {"MaxEgressCount": {"value": "42", "mode": "enforce"}} ' type: object description: '[Security attributes](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing (ZPR)](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/overview.htm) policy to control access to ZPR-supported resources. ' type: object shape: description: The shape of a firewall to determine the bandwidth that the firewall allows. maxLength: 50 type: string subnetId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the Network Firewall. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The time instant at which the Network Firewall was created in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The time instant at which the Network Firewall was updated in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - subnetId - networkFirewallPolicyId - freeformTags - definedTags type: object MappedSecretSummary: description: Mapped secret used on the firewall policy rules. properties: description: description: The description of the mapped secret. This field can be used to add additional info. maxLength: 1000 minLength: 0 type: string name: description: Name of the secret. maxLength: 58 minLength: 6 type: string parentResourceId: description: OCID of the Network Firewall Policy this mapped secret belongs to. maxLength: 255 minLength: 1 type: string source: description: Source of the secrets, where the secrets are stored. type: string type: default: SSL_INBOUND_INSPECTION description: "Type of the secrets mapped based on the policy.\n\n * `SSL_INBOUND_INSPECTION`: For Inbound inspection of SSL traffic.\n * `SSL_FORWARD_PROXY`: For forward proxy certificates for SSL inspection.\n" enum: - SSL_INBOUND_INSPECTION - SSL_FORWARD_PROXY type: string x-obmcs-top-level-enum: '#/definitions/InspectionType' required: - name - source - type - parentResourceId type: object MappedSecret: description: Mapped secret used on the firewall policy rules. discriminator: propertyName: source properties: source: description: Source of the secrets, where the secrets are stored. type: string type: default: SSL_INBOUND_INSPECTION description: "Type of the secrets mapped based on the policy.\n\n * `SSL_INBOUND_INSPECTION`: For Inbound inspection of SSL traffic.\n * `SSL_FORWARD_PROXY`: For forward proxy certificates for SSL inspection.\n" enum: - SSL_INBOUND_INSPECTION - SSL_FORWARD_PROXY type: string required: - source - type type: object SecurityRule: description: 'Security Rule used in the firewall policy rules. Security Rules determine whether to block or allow a session based on traffic attributes, such as the source and destination IP address, protocol/port, and the HTTP(S) target URL. ' properties: action: description: "Types of Action on the Traffic flow.\n\n * ALLOW - Allows the traffic.\n * DROP - Silently drops the traffic, e.g. without sending a TCP reset.\n * REJECT - Rejects the traffic, sending a TCP reset to client and/or server as applicable.\n * INSPECT - Inspects traffic for vulnerability as specified in `inspection`, which may result in rejection.\n" enum: - ALLOW - DROP - REJECT - INSPECT type: string condition: $ref: '#/components/schemas/SecurityRuleMatchCriteria' inspection: description: "Type of inspection to affect the Traffic flow. This is only applicable if action is INSPECT.\n\n * INTRUSION_DETECTION - Intrusion Detection.\n * INTRUSION_PREVENTION - Intrusion Detection and Prevention. Traffic classified as potentially malicious will be rejected as described in `type`.\n" enum: - INTRUSION_DETECTION - INTRUSION_PREVENTION type: string name: description: Name for the Security rule, must be unique within the policy. format: x-obmcs-ascii-identifier maxLength: 63 minLength: 2 pattern: ^[a-zA-Z](-?[a-zA-Z_0-9])*$ type: string required: - name - condition - action type: object WorkRequestLogEntryCollection: description: Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata. properties: items: description: List of workRequestLogEntries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object parameters: AvailabilityDomainQueryParam: description: 'A filter to return only resources that are present within the specified availability domain. To get a list of availability domains for a tenancy, use [ListAvailabilityDomains](#/en/identity/20160918/AvailabilityDomain/ListAvailabilityDomains) operation. Example: `kIdk:PHX-AD-1` ' in: query name: availabilityDomain x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string UrlListNameIdentifierPathParam: description: Unique name identifier for url lists in the scope of Network Firewall Policy. in: path name: urlListName required: true schema: type: string maxLength: 28 minLength: 2 NatRuleOrderQueryParam: description: Unique priority order for NAT rules in the Network Firewall policy. in: query name: natRulePriorityOrder required: false x-default-description: If this parameter is not given, the default rules would be listed without this filter. schema: type: integer minimum: 0 SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string LifecycleStateQueryParam: description: A filter to return only resources with a lifecycleState matching the given value. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/LifecycleState' schema: type: string enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION ApplicationNameIdentifierPathParam: description: Unique identifier for Applications. in: path name: applicationName required: true schema: type: string maxLength: 31 minLength: 2 SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated ResourceIdentifierQueryParam: description: The ID of the resource affected by the work request. in: query name: resourceId x-default-description: 'null' schema: type: string NetworkFirewallPolicyIdentifierQueryParam: description: Unique Network Firewall Policy identifier in: query name: id x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 WorkRequestStatusQueryParam: description: A filter to return only resources their lifecycleState matches the given OperationStatus. in: query name: status required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - NEEDS_ATTENTION - CANCELING - CANCELED NetworkFirewallPolicyIdQueryParam: description: A filter to return only resources that match the entire networkFirewallPolicyId given. in: query name: networkFirewallPolicyId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string ApplicationGroupNameIdentifierPathParam: description: Unique name identifier for Application Lists in the scope of Network Firewall Policy. in: path name: applicationGroupName required: true schema: type: string maxLength: 28 minLength: 2 ServiceListNameIdentifierPathParam: description: Unique name identifier for Service Lists in the scope of Network Firewall Policy. in: path name: serviceListName required: true schema: type: string maxLength: 28 minLength: 2 TunnelInspectionRuleOrderQueryParam: description: Unique priority order for Tunnel Inspection rules in the network firewall policy. in: query name: tunnelInspectionRulePriorityOrder required: false x-default-description: Order of the Tunnel Inspection Rule in the given rule list. schema: type: integer minimum: 0 AddressListNameIdentifierPathParam: description: Unique identifier for address lists. in: path name: addressListName required: true schema: type: string maxLength: 28 minLength: 2 SecurityRuleOrderQueryParam: description: Unique priority order for Security Rules in the network firewall policy. in: query name: securityRulePriorityOrder required: false x-default-description: Order of the security Rule in the given rule list. schema: type: integer minimum: 0 DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PaginationTokenQueryParam: description: A token representing the position at which to start retrieving results. This must come from the `opc-next-page` or `opc-prev-page` header field of a previous response. in: query name: page x-default-description: 'null' schema: type: string minLength: 1 ServiceNameIdentifierPathParam: description: Unique identifier for Services. in: path name: serviceName required: true schema: type: string maxLength: 28 minLength: 2 WorkRequestIdQueryParam: description: The ID of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' schema: type: string SecurityRuleNameIdentifierPathParam: description: Unique identifier for Security Rules in the network firewall policy. in: path name: securityRuleName required: true schema: type: string maxLength: 63 minLength: 2 RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 NetworkFirewallIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Network Firewall resource. in: query name: id x-default-description: 'null' schema: type: string WorkRequestSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. ' in: query name: sortBy schema: type: string enum: - timeAccepted default: timeAccepted DecryptionProfileNameIdentifierPathParam: description: Unique identifier for Decryption Profiles. in: path name: decryptionProfileName required: true schema: type: string maxLength: 28 minLength: 2 NetworkFirewallIdentifierParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Network Firewall resource. in: path name: networkFirewallId required: true schema: type: string DecryptionRuleOrderQueryParam: description: Unique priority order for Decryption Rules in the network firewall policy. in: query name: decryptionRulePriorityOrder required: false x-default-description: If this parameter is not given, the default rules would be listed without this filter. schema: type: integer minimum: 0 MappedSecretNameIdentifierPathParam: description: Unique identifier for Mapped Secrets. in: path name: mappedSecretName required: true schema: type: string maxLength: 58 minLength: 6 NetworkFirewallPolicyIdentifierPathParam: description: Unique Network Firewall Policy identifier in: path name: networkFirewallPolicyId required: true schema: type: string maxLength: 255 minLength: 1 NetworkFirewallIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Network Firewall resource. in: path name: networkFirewallId required: true schema: type: string CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId required: true x-default-description: 'null' schema: type: string TunnelInspectionRuleNameIdentifierPathParam: description: Unique identifier for Tunnel Inspection Rules in the network firewall policy. in: path name: tunnelInspectionRuleName required: true schema: type: string maxLength: 63 minLength: 2 PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 100 minimum: 1 DecryptionRuleNameIdentifierPathParam: description: Unique identifier for Decryption Rules in the network firewall policy. in: path name: decryptionRuleName required: true schema: type: string maxLength: 63 minLength: 2 NetworkFirewallPolicyIdentifierPathParam_2: description: Unique Network Firewall Policy identifier in: path name: networkFirewallPolicyId required: true schema: type: string NatRuleNameIdentifierPathParam: description: Unique identifier for NAT rules in the Network Firewall policy. in: path name: natRuleName required: true schema: type: string maxLength: 63 minLength: 2 responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-refined-from: - oci-network-firewall-1-openapi.yaml - oci-network-firewall-openapi.yaml x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.idm.agcs.cp