Web Application Firewall Functions

CHANGE_NETWORK_ADDRESS_LIST_COMPARTMENT Function

Moves a NetworkAddressList resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_network_address_list_compartment (
  network_address_list_id varchar2,
  change_network_address_list_compartment_details dbms_cloud_oci_waf_change_network_address_list_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_change_network_address_list_compartment_response_t;

Parameters

Parameter	Description
`network_address_list_id`	(required) The OCID of the NetworkAddressList.
`change_network_address_list_compartment_details`	(required) The information to be updated.
`if_match`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_WEB_APP_FIREWALL_COMPARTMENT Function

Moves a Web App Firewall resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_web_app_firewall_compartment (
  web_app_firewall_id varchar2,
  change_web_app_firewall_compartment_details dbms_cloud_oci_waf_change_web_app_firewall_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_change_web_app_firewall_compartment_response_t;

Parameters

Parameter	Description
`web_app_firewall_id`	(required) The OCID of the WebAppFirewall.
`change_web_app_firewall_compartment_details`	(required) The information to be updated.
`if_match`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_WEB_APP_FIREWALL_POLICY_COMPARTMENT Function

Moves a WebAppFirewallfPolicy resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_web_app_firewall_policy_compartment (
  web_app_firewall_policy_id varchar2,
  change_web_app_firewall_policy_compartment_details dbms_cloud_oci_waf_change_web_app_firewall_policy_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_change_web_app_firewall_policy_compartment_response_t;

Parameters

Parameter	Description
`web_app_firewall_policy_id`	(required) The OCID of the WebAppFirewallPolicy.
`change_web_app_firewall_policy_compartment_details`	(required) The information to be updated.
`if_match`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_NETWORK_ADDRESS_LIST Function

Creates a new NetworkAddressList.

Syntax

FUNCTION create_network_address_list (
  create_network_address_list_details dbms_cloud_oci_waf_create_network_address_list_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_create_network_address_list_response_t;

Parameters

Parameter	Description
`create_network_address_list_details`	(required) Details for the new NetworkAddressList.
`opc_retry_token`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_WEB_APP_FIREWALL Function

Creates a new WebAppFirewall.

Syntax

FUNCTION create_web_app_firewall (
  create_web_app_firewall_details dbms_cloud_oci_waf_create_web_app_firewall_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_create_web_app_firewall_response_t;

Parameters

Parameter	Description
`create_web_app_firewall_details`	(required) Details for the new Web App Firewall.
`opc_retry_token`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_WEB_APP_FIREWALL_POLICY Function

Creates a new WebAppFirewallPolicy.

Syntax

FUNCTION create_web_app_firewall_policy (
  create_web_app_firewall_policy_details dbms_cloud_oci_waf_create_web_app_firewall_policy_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_create_web_app_firewall_policy_response_t;

Parameters

Parameter	Description
`create_web_app_firewall_policy_details`	(required) Details for the new WebAppFirewallPolicy.
`opc_retry_token`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_NETWORK_ADDRESS_LIST Function

Deletes a NetworkAddressList resource identified by the OCID.

Syntax

FUNCTION delete_network_address_list (
  network_address_list_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_delete_network_address_list_response_t;

Parameters

Parameter	Description
`network_address_list_id`	(required) The OCID of the NetworkAddressList.
`if_match`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_WEB_APP_FIREWALL Function

Deletes a WebAppFirewall resource identified by the OCID.

Syntax

FUNCTION delete_web_app_firewall (
  web_app_firewall_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_delete_web_app_firewall_response_t;

Parameters

Parameter	Description
`web_app_firewall_id`	(required) The OCID of the WebAppFirewall.
`if_match`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_WEB_APP_FIREWALL_POLICY Function

Deletes a WebAppFirewallPolicy resource identified by the OCID.

Syntax

FUNCTION delete_web_app_firewall_policy (
  web_app_firewall_policy_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_delete_web_app_firewall_policy_response_t;

Parameters

Parameter	Description
`web_app_firewall_policy_id`	(required) The OCID of the WebAppFirewallPolicy.
`if_match`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_NETWORK_ADDRESS_LIST Function

Gets a NetworkAddressList by OCID.

Syntax

FUNCTION get_network_address_list (
  network_address_list_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_get_network_address_list_response_t;

Parameters

Parameter	Description
`network_address_list_id`	(required) The OCID of the NetworkAddressList.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WEB_APP_FIREWALL Function

Gets a WebAppFirewall by OCID.

Syntax

FUNCTION get_web_app_firewall (
  web_app_firewall_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_get_web_app_firewall_response_t;

Parameters

Parameter	Description
`web_app_firewall_id`	(required) The OCID of the WebAppFirewall.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WEB_APP_FIREWALL_POLICY Function

Gets a WebAppFirewallPolicy with the given OCID.

Syntax

FUNCTION get_web_app_firewall_policy (
  web_app_firewall_policy_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_get_web_app_firewall_policy_response_t;

Parameters

Parameter	Description
`web_app_firewall_policy_id`	(required) The OCID of the WebAppFirewallPolicy.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

Gets the status of the WorkRequest with the given OCID.

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_NETWORK_ADDRESS_LISTS Function

Gets a list of all NetworkAddressLists in a compartment.

Syntax

FUNCTION list_network_address_lists (
  compartment_id varchar2,
  lifecycle_state dbms_cloud_oci_waf_varchar2_tbl DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_list_network_address_lists_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment in which to list resources.
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycleState.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`id`	(optional) A filter to return only the NetworkAddressList with the given OCID.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PROTECTION_CAPABILITIES Function

Lists of protection capabilities filtered by query parameters.

Syntax

FUNCTION list_protection_capabilities (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  key varchar2 DEFAULT NULL,
  is_latest_version dbms_cloud_oci_waf_number_tbl DEFAULT NULL,
  l_type varchar2 DEFAULT NULL,
  group_tag dbms_cloud_oci_waf_varchar2_tbl DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_list_protection_capabilities_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment in which to list resources.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`limit`	(optional) The maximum number of items to return.
`key`	(optional) The unique key of protection capability to filter by.
`is_latest_version`	(optional) A filter to return only resources that matches given isLatestVersion.
`l_type`	(optional) A filter to return only resources that matches given type.
`group_tag`	(optional) A filter to return only resources that are accociated given group tag.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for key is descending. Default order for type is descending. Default order for displayName is ascending. If no value is specified key is default. Allowed values are: 'key', 'type', 'displayName'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PROTECTION_CAPABILITY_GROUP_TAGS Function

Lists of available group tags filtered by query parameters.

Syntax

FUNCTION list_protection_capability_group_tags (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  l_type varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_list_protection_capability_group_tags_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment in which to list resources.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`limit`	(optional) The maximum number of items to return.
`l_type`	(optional) A filter to return only resources that matches given type.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for name is ascending. If no value is specified name is default. Allowed values are: 'name'
`name`	(optional) A filter to return only resources that match the entire name given.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WEB_APP_FIREWALL_POLICIES Function

Gets a list of all WebAppFirewallPolicies in a compartment.

Syntax

FUNCTION list_web_app_firewall_policies (
  compartment_id varchar2,
  lifecycle_state dbms_cloud_oci_waf_varchar2_tbl DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_list_web_app_firewall_policies_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment in which to list resources.
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycleState.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`id`	(optional) A filter to return only the WebAppFirewallPolicy with the given OCID.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WEB_APP_FIREWALLS Function

Gets a list of all WebAppFirewalls in a compartment.

Syntax

FUNCTION list_web_app_firewalls (
  compartment_id varchar2,
  id varchar2 DEFAULT NULL,
  web_app_firewall_policy_id varchar2 DEFAULT NULL,
  lifecycle_state dbms_cloud_oci_waf_varchar2_tbl DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_list_web_app_firewalls_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment in which to list resources.
`id`	(optional) A filter to return only the WebAppFirewall with the given OCID.
`web_app_firewall_policy_id`	(optional) A filter to return only the WebAppFirewall with the given OCID of related WebAppFirewallPolicy.
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycleState.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_ERRORS Function

Return a (paginated) list of errors for a given WorkRequest.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_LOGS Function

Return a (paginated) list of logs for a given WorkRequest.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

Lists the WorkRequests in a compartment.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  work_request_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment in which to list resources.
`work_request_id`	(optional) The OCID of the asynchronous work request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_NETWORK_ADDRESS_LIST Function

Update the NetworkAddressList identified by the OCID.

Syntax

FUNCTION update_network_address_list (
  network_address_list_id varchar2,
  update_network_address_list_details dbms_cloud_oci_waf_update_network_address_list_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_update_network_address_list_response_t;

Parameters

Parameter	Description
`network_address_list_id`	(required) The OCID of the NetworkAddressList.
`update_network_address_list_details`	(required) The information to be updated.
`if_match`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_WEB_APP_FIREWALL Function

Updates the WebAppFirewall identified by the OCID.

Syntax

FUNCTION update_web_app_firewall (
  web_app_firewall_id varchar2,
  update_web_app_firewall_details dbms_cloud_oci_waf_update_web_app_firewall_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_update_web_app_firewall_response_t;

Parameters

Parameter	Description
`web_app_firewall_id`	(required) The OCID of the WebAppFirewall.
`update_web_app_firewall_details`	(required) The information to be updated.
`if_match`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_WEB_APP_FIREWALL_POLICY Function

Update the WebAppFirewallPolicy identified by the OCID.

Syntax

FUNCTION update_web_app_firewall_policy (
  web_app_firewall_policy_id varchar2,
  update_web_app_firewall_policy_details dbms_cloud_oci_waf_update_web_app_firewall_policy_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waf_waf_update_web_app_firewall_policy_response_t;

Parameters

Parameter	Description
`web_app_firewall_policy_id`	(required) The OCID of the WebAppFirewallPolicy.
`update_web_app_firewall_policy_details`	(required) The information to be updated.
`if_match`	(optional) 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.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://waf.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

CHANGE_NETWORK_ADDRESS_LIST_COMPARTMENT Function 🔗

CHANGE_WEB_APP_FIREWALL_COMPARTMENT Function 🔗

CHANGE_WEB_APP_FIREWALL_POLICY_COMPARTMENT Function 🔗

CREATE_NETWORK_ADDRESS_LIST Function 🔗

CREATE_WEB_APP_FIREWALL Function 🔗

CREATE_WEB_APP_FIREWALL_POLICY Function 🔗

DELETE_NETWORK_ADDRESS_LIST Function 🔗

DELETE_WEB_APP_FIREWALL Function 🔗

DELETE_WEB_APP_FIREWALL_POLICY Function 🔗

GET_NETWORK_ADDRESS_LIST Function 🔗

GET_WEB_APP_FIREWALL Function 🔗

GET_WEB_APP_FIREWALL_POLICY Function 🔗

GET_WORK_REQUEST Function 🔗

LIST_NETWORK_ADDRESS_LISTS Function 🔗

LIST_PROTECTION_CAPABILITIES Function 🔗

LIST_PROTECTION_CAPABILITY_GROUP_TAGS Function 🔗

LIST_WEB_APP_FIREWALL_POLICIES Function 🔗

LIST_WEB_APP_FIREWALLS Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUESTS Function 🔗

UPDATE_NETWORK_ADDRESS_LIST Function 🔗

UPDATE_WEB_APP_FIREWALL Function 🔗

UPDATE_WEB_APP_FIREWALL_POLICY Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CHANGE_NETWORK_ADDRESS_LIST_COMPARTMENT Function

CHANGE_WEB_APP_FIREWALL_COMPARTMENT Function

CHANGE_WEB_APP_FIREWALL_POLICY_COMPARTMENT Function

CREATE_NETWORK_ADDRESS_LIST Function

CREATE_WEB_APP_FIREWALL Function

CREATE_WEB_APP_FIREWALL_POLICY Function

DELETE_NETWORK_ADDRESS_LIST Function

DELETE_WEB_APP_FIREWALL Function

DELETE_WEB_APP_FIREWALL_POLICY Function

GET_NETWORK_ADDRESS_LIST Function

GET_WEB_APP_FIREWALL Function

GET_WEB_APP_FIREWALL_POLICY Function

GET_WORK_REQUEST Function

LIST_NETWORK_ADDRESS_LISTS Function

LIST_PROTECTION_CAPABILITIES Function

LIST_PROTECTION_CAPABILITY_GROUP_TAGS Function

LIST_WEB_APP_FIREWALL_POLICIES Function

LIST_WEB_APP_FIREWALLS Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

UPDATE_NETWORK_ADDRESS_LIST Function

UPDATE_WEB_APP_FIREWALL Function

UPDATE_WEB_APP_FIREWALL_POLICY Function