WafClient

class oci.waf.WafClient(config, **kwargs)

API for the Web Application Firewall service. Use this API to manage regional Web App Firewalls and corresponding policies for protecting HTTP services.

Methods

__init__(config, **kwargs) Creates a new service client
change_network_address_list_compartment(…) Moves a NetworkAddressList resource from one compartment to another.
change_web_app_firewall_compartment(…) Moves a Web App Firewall resource from one compartment to another.
change_web_app_firewall_policy_compartment(…) Moves a WebAppFirewallfPolicy resource from one compartment to another.
create_network_address_list(…) Creates a new NetworkAddressList.
create_web_app_firewall(…) Creates a new WebAppFirewall.
create_web_app_firewall_policy(…) Creates a new WebAppFirewallPolicy.
delete_network_address_list(…) Deletes a NetworkAddressList resource identified by the OCID.
delete_web_app_firewall(web_app_firewall_id, …) Deletes a WebAppFirewall resource identified by the OCID.
delete_web_app_firewall_policy(…) Deletes a WebAppFirewallPolicy resource identified by the OCID.
get_network_address_list(…) Gets a NetworkAddressList by OCID.
get_web_app_firewall(web_app_firewall_id, …) Gets a WebAppFirewall by OCID.
get_web_app_firewall_policy(…) Gets a WebAppFirewallPolicy with the given OCID.
get_work_request(work_request_id, **kwargs) Gets the status of the WorkRequest with the given OCID.
list_network_address_lists(compartment_id, …) Gets a list of all NetworkAddressLists in a compartment.
list_protection_capabilities(compartment_id, …) Lists of protection capabilities filtered by query parameters.
list_protection_capability_group_tags(…) Lists of available group tags filtered by query parameters.
list_web_app_firewall_policies(…) Gets a list of all WebAppFirewallPolicies in a compartment.
list_web_app_firewalls(compartment_id, **kwargs) Gets a list of all WebAppFirewalls in a compartment.
list_work_request_errors(work_request_id, …) Return a (paginated) list of errors for a given WorkRequest.
list_work_request_logs(work_request_id, **kwargs) Return a (paginated) list of logs for a given WorkRequest.
list_work_requests(compartment_id, **kwargs) Lists the WorkRequests in a compartment.
update_network_address_list(…) Update the NetworkAddressList identified by the OCID.
update_web_app_firewall(web_app_firewall_id, …) Updates the WebAppFirewall identified by the OCID.
update_web_app_firewall_policy(…) Update the WebAppFirewallPolicy identified by the OCID.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

  • circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
  • circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
  • allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
change_network_address_list_compartment(network_address_list_id, change_network_address_list_compartment_details, **kwargs)

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

Parameters:
  • network_address_list_id (str) –

    (required) The OCID of the NetworkAddressList.

  • change_network_address_list_compartment_details (oci.waf.models.ChangeNetworkAddressListCompartmentDetails) – (required) The information to be updated.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_network_address_list_compartment API.

change_web_app_firewall_compartment(web_app_firewall_id, change_web_app_firewall_compartment_details, **kwargs)

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

Parameters:
  • web_app_firewall_id (str) –

    (required) The OCID of the WebAppFirewall.

  • change_web_app_firewall_compartment_details (oci.waf.models.ChangeWebAppFirewallCompartmentDetails) – (required) The information to be updated.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_web_app_firewall_compartment API.

change_web_app_firewall_policy_compartment(web_app_firewall_policy_id, change_web_app_firewall_policy_compartment_details, **kwargs)

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

Parameters:
  • web_app_firewall_policy_id (str) –

    (required) The OCID of the WebAppFirewallPolicy.

  • change_web_app_firewall_policy_compartment_details (oci.waf.models.ChangeWebAppFirewallPolicyCompartmentDetails) – (required) The information to be updated.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_web_app_firewall_policy_compartment API.

create_network_address_list(create_network_address_list_details, **kwargs)

Creates a new NetworkAddressList.

Parameters:
  • create_network_address_list_details (oci.waf.models.CreateNetworkAddressListDetails) – (required) Details for the new NetworkAddressList.
  • opc_retry_token (str) – (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 (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type NetworkAddressList

Return type:

Response

Example:

Click here to see an example of how to use create_network_address_list API.

create_web_app_firewall(create_web_app_firewall_details, **kwargs)

Creates a new WebAppFirewall.

Parameters:
  • create_web_app_firewall_details (oci.waf.models.CreateWebAppFirewallDetails) – (required) Details for the new Web App Firewall.
  • opc_retry_token (str) – (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 (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WebAppFirewall

Return type:

Response

Example:

Click here to see an example of how to use create_web_app_firewall API.

create_web_app_firewall_policy(create_web_app_firewall_policy_details, **kwargs)

Creates a new WebAppFirewallPolicy.

Parameters:
  • create_web_app_firewall_policy_details (oci.waf.models.CreateWebAppFirewallPolicyDetails) – (required) Details for the new WebAppFirewallPolicy.
  • opc_retry_token (str) – (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 (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WebAppFirewallPolicy

Return type:

Response

Example:

Click here to see an example of how to use create_web_app_firewall_policy API.

delete_network_address_list(network_address_list_id, **kwargs)

Deletes a NetworkAddressList resource identified by the OCID.

Parameters:
  • network_address_list_id (str) –

    (required) The OCID of the NetworkAddressList.

  • if_match (str) – (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 (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_network_address_list API.

delete_web_app_firewall(web_app_firewall_id, **kwargs)

Deletes a WebAppFirewall resource identified by the OCID.

Parameters:
  • web_app_firewall_id (str) –

    (required) The OCID of the WebAppFirewall.

  • if_match (str) – (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 (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_web_app_firewall API.

delete_web_app_firewall_policy(web_app_firewall_policy_id, **kwargs)

Deletes a WebAppFirewallPolicy resource identified by the OCID.

Parameters:
  • web_app_firewall_policy_id (str) –

    (required) The OCID of the WebAppFirewallPolicy.

  • if_match (str) – (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 (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_web_app_firewall_policy API.

get_network_address_list(network_address_list_id, **kwargs)

Gets a NetworkAddressList by OCID.

Parameters:
  • network_address_list_id (str) –

    (required) The OCID of the NetworkAddressList.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type NetworkAddressList

Return type:

Response

Example:

Click here to see an example of how to use get_network_address_list API.

get_web_app_firewall(web_app_firewall_id, **kwargs)

Gets a WebAppFirewall by OCID.

Parameters:
  • web_app_firewall_id (str) –

    (required) The OCID of the WebAppFirewall.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WebAppFirewall

Return type:

Response

Example:

Click here to see an example of how to use get_web_app_firewall API.

get_web_app_firewall_policy(web_app_firewall_policy_id, **kwargs)

Gets a WebAppFirewallPolicy with the given OCID.

Parameters:
  • web_app_firewall_policy_id (str) –

    (required) The OCID of the WebAppFirewallPolicy.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WebAppFirewallPolicy

Return type:

Response

Example:

Click here to see an example of how to use get_web_app_firewall_policy API.

get_work_request(work_request_id, **kwargs)

Gets the status of the WorkRequest with the given OCID.

Parameters:
  • work_request_id (str) –

    (required) The OCID of the asynchronous request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WorkRequest

Return type:

Response

Example:

Click here to see an example of how to use get_work_request API.

list_network_address_lists(compartment_id, **kwargs)

Gets a list of all NetworkAddressLists in a compartment.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment in which to list resources.

  • lifecycle_state (list[NetworkAddressListLifecycleState]) – (optional) A filter to return only resources that match the given lifecycleState.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • id (str) –

    (optional) A filter to return only the NetworkAddressList with the given OCID.

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (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 (str) –

    (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type NetworkAddressListCollection

Return type:

Response

Example:

Click here to see an example of how to use list_network_address_lists API.

list_protection_capabilities(compartment_id, **kwargs)

Lists of protection capabilities filtered by query parameters.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment in which to list resources.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • page (str) – (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 (int) – (optional) The maximum number of items to return.
  • key (str) – (optional) The unique key of protection capability to filter by.
  • is_latest_version (list[bool]) – (optional) A filter to return only resources that matches given isLatestVersion.
  • type (str) –

    (optional) A filter to return only resources that matches given type.

    Allowed values are: “REQUEST_PROTECTION_CAPABILITY”, “RESPONSE_PROTECTION_CAPABILITY”

  • group_tag (list[str]) – (optional) A filter to return only resources that are accociated given group tag.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • sort_order (str) –

    (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type ProtectionCapabilityCollection

Return type:

Response

Example:

Click here to see an example of how to use list_protection_capabilities API.

list_protection_capability_group_tags(compartment_id, **kwargs)

Lists of available group tags filtered by query parameters.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment in which to list resources.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • page (str) – (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 (int) – (optional) The maximum number of items to return.
  • type (str) –

    (optional) A filter to return only resources that matches given type.

    Allowed values are: “REQUEST_PROTECTION_CAPABILITY”, “RESPONSE_PROTECTION_CAPABILITY”

  • sort_order (str) –

    (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) A filter to return only resources that match the entire name given.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type ProtectionCapabilityGroupTagCollection

Return type:

Response

Example:

Click here to see an example of how to use list_protection_capability_group_tags API.

list_web_app_firewall_policies(compartment_id, **kwargs)

Gets a list of all WebAppFirewallPolicies in a compartment.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment in which to list resources.

  • lifecycle_state (list[WebAppFirewallPolicyLifecycleState]) – (optional) A filter to return only resources that match the given lifecycleState.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • id (str) –

    (optional) A filter to return only the WebAppFirewallPolicy with the given OCID.

  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (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 (str) –

    (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WebAppFirewallPolicyCollection

Return type:

Response

Example:

Click here to see an example of how to use list_web_app_firewall_policies API.

list_web_app_firewalls(compartment_id, **kwargs)

Gets a list of all WebAppFirewalls in a compartment.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment in which to list resources.

  • id (str) –

    (optional) A filter to return only the WebAppFirewall with the given OCID.

  • web_app_firewall_policy_id (str) –

    (optional) A filter to return only the WebAppFirewall with the given OCID of related WebAppFirewallPolicy.

  • lifecycle_state (list[WebAppFirewallLifecycleState]) – (optional) A filter to return only resources that match the given lifecycleState.
  • display_name (str) – (optional) A filter to return only resources that match the entire display name given.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (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 (str) –

    (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (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 (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WebAppFirewallCollection

Return type:

Response

Example:

Click here to see an example of how to use list_web_app_firewalls API.

list_work_request_errors(work_request_id, **kwargs)

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

Parameters:
  • work_request_id (str) –

    (required) The OCID of the asynchronous request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • page (str) – (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 (int) – (optional) The maximum number of items to return.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WorkRequestErrorCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_request_errors API.

list_work_request_logs(work_request_id, **kwargs)

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

Parameters:
  • work_request_id (str) –

    (required) The OCID of the asynchronous request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • page (str) – (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 (int) – (optional) The maximum number of items to return.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WorkRequestLogEntryCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_request_logs API.

list_work_requests(compartment_id, **kwargs)

Lists the WorkRequests in a compartment.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment in which to list resources.

  • work_request_id (str) –

    (optional) The OCID of the asynchronous work request.

  • opc_request_id (str) – (optional) The client request ID for tracing.
  • page (str) – (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 (int) – (optional) The maximum number of items to return.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WorkRequestCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_requests API.

update_network_address_list(network_address_list_id, update_network_address_list_details, **kwargs)

Update the NetworkAddressList identified by the OCID.

Parameters:
  • network_address_list_id (str) –

    (required) The OCID of the NetworkAddressList.

  • update_network_address_list_details (oci.waf.models.UpdateNetworkAddressListDetails) – (required) The information to be updated.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_network_address_list API.

update_web_app_firewall(web_app_firewall_id, update_web_app_firewall_details, **kwargs)

Updates the WebAppFirewall identified by the OCID.

Parameters:
  • web_app_firewall_id (str) –

    (required) The OCID of the WebAppFirewall.

  • update_web_app_firewall_details (oci.waf.models.UpdateWebAppFirewallDetails) – (required) The information to be updated.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_web_app_firewall API.

update_web_app_firewall_policy(web_app_firewall_policy_id, update_web_app_firewall_policy_details, **kwargs)

Update the WebAppFirewallPolicy identified by the OCID.

Parameters:
  • web_app_firewall_policy_id (str) –

    (required) The OCID of the WebAppFirewallPolicy.

  • update_web_app_firewall_policy_details (oci.waf.models.UpdateWebAppFirewallPolicyDetails) – (required) The information to be updated.
  • if_match (str) – (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 (str) – (optional) The client request ID for tracing.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_web_app_firewall_policy API.