Class WaasClient
Service client instance for Waas.
Implements
Inherited Members
Namespace: Oci.WaasService
Assembly: OCI.DotNetSDK.Waas.dll
Syntax
public class WaasClient : RegionalClientBase, IDisposable
Constructors
WaasClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public WaasClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public WaasPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
WaasPaginators |
Waiters
Declaration
public WaasWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
WaasWaiters |
Methods
AcceptRecommendations(AcceptRecommendationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Accepts a list of recommended Web Application Firewall protection rules. Web Application Firewall protection rule recommendations are sets of rules generated by observed traffic patterns through the Web Application Firewall and are meant to optimize the Web Application Firewall's security profile. Only the rules specified in the request body will be updated; all other rules will remain unchanged.
<br/>
Use the GET /waasPolicies/{waasPolicyId}/wafConfig/recommendations
method to view a list of recommended Web Application Firewall protection rules. For more information, see WAF Protection Rules.
Declaration
public Task<AcceptRecommendationsResponse> AcceptRecommendations(AcceptRecommendationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AcceptRecommendationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AcceptRecommendationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AcceptRecommendations API.
CancelWorkRequest(CancelWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Cancels a specified work request.
Declaration
public Task<CancelWorkRequestResponse> CancelWorkRequest(CancelWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CancelWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CancelWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CancelWorkRequest API.
ChangeAddressListCompartment(ChangeAddressListCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves address list into a different compartment. When provided, If-Match is checked against ETag values of the address list. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeAddressListCompartmentResponse> ChangeAddressListCompartment(ChangeAddressListCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeAddressListCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeAddressListCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeAddressListCompartment API.
ChangeCertificateCompartment(ChangeCertificateCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves certificate into a different compartment. When provided, If-Match is checked against ETag values of the certificate. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeCertificateCompartmentResponse> ChangeCertificateCompartment(ChangeCertificateCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeCertificateCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeCertificateCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeCertificateCompartment API.
ChangeCustomProtectionRuleCompartment(ChangeCustomProtectionRuleCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a custom protection rule into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the custom protection rule. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeCustomProtectionRuleCompartmentResponse> ChangeCustomProtectionRuleCompartment(ChangeCustomProtectionRuleCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeCustomProtectionRuleCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeCustomProtectionRuleCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeCustomProtectionRuleCompartment API.
ChangeWaasPolicyCompartment(ChangeWaasPolicyCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves WAAS policy into a different compartment. When provided, If-Match is checked against ETag values of the WAAS policy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Declaration
public Task<ChangeWaasPolicyCompartmentResponse> ChangeWaasPolicyCompartment(ChangeWaasPolicyCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeWaasPolicyCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeWaasPolicyCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeWaasPolicyCompartment API.
CreateAddressList(CreateAddressListRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates an address list in a set compartment and allows it to be used in a WAAS policy and referenced by access rules. Addresses can be IP addresses and CIDR notations.
Declaration
public Task<CreateAddressListResponse> CreateAddressList(CreateAddressListRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateAddressListRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateAddressListResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateAddressList API.
CreateCertificate(CreateCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Allows an SSL certificate to be added to a WAAS policy. The Web Application Firewall terminates SSL connections to inspect requests in runtime, and then re-encrypts requests before sending them to the origin for fulfillment. <br/> For more information, see WAF Settings.
Declaration
public Task<CreateCertificateResponse> CreateCertificate(CreateCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateCertificateRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateCertificateResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateCertificate API.
CreateCustomProtectionRule(CreateCustomProtectionRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new custom protection rule in the specified compartment. <br/> Custom protection rules allow you to create rules in addition to the rulesets provided by the Web Application Firewall service, including rules from ModSecurity. The syntax for custom rules is based on the ModSecurity syntax. For more information about custom protection rules, see Custom Protection Rules.
Declaration
public Task<CreateCustomProtectionRuleResponse> CreateCustomProtectionRule(CreateCustomProtectionRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateCustomProtectionRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateCustomProtectionRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateCustomProtectionRule API.
CreateWaasPolicy(CreateWaasPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new Web Application Acceleration and Security (WAAS) policy in the specified compartment. A WAAS policy must be established before creating Web Application Firewall (WAF) rules. To use WAF rules, your web application's origin servers must defined in the WaasPolicy
schema.
<br/>
A domain name must be specified when creating a WAAS policy. The domain name should be different from the origins specified in your WaasPolicy
. Once domain name is entered and stored, it is unchangeable.
<br/>
Use the record data returned in the cname
field of the WaasPolicy
object to create a CNAME record in your DNS configuration that will direct your domain's traffic through the WAF.
<br/>
For the purposes of access control, you must provide the OCID of the compartment where you want the service to reside. For information about access control and compartments, see Overview of the IAM Service.
<br/>
You must specify a display name and domain for the WAAS policy. The display name does not have to be unique and can be changed. The domain name should be different from every origin specified in WaasPolicy
.
<br/>
All Oracle Cloud Infrastructure resources, including WAAS policies, receive a unique, Oracle-assigned ID called an Oracle Cloud Identifier (OCID). When a resource is created, you can find its OCID in the response. You can also retrieve a resource's OCID by using a list API operation for that resource type, or by viewing the resource in the Console. Fore more information, see Resource Identifiers.
<br/>
Note: After sending the POST request, the new object's state will temporarily be CREATING
. Ensure that the resource's state has changed to ACTIVE
before use.
Declaration
public Task<CreateWaasPolicyResponse> CreateWaasPolicy(CreateWaasPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateWaasPolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateWaasPolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateWaasPolicy API.
DeleteAddressList(DeleteAddressListRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the address list from the compartment if it is not used.
Declaration
public Task<DeleteAddressListResponse> DeleteAddressList(DeleteAddressListRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteAddressListRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteAddressListResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteAddressList API.
DeleteCertificate(DeleteCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes an SSL certificate from the WAAS service.
Declaration
public Task<DeleteCertificateResponse> DeleteCertificate(DeleteCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteCertificateRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteCertificateResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteCertificate API.
DeleteCustomProtectionRule(DeleteCustomProtectionRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a Custom Protection rule.
Declaration
public Task<DeleteCustomProtectionRuleResponse> DeleteCustomProtectionRule(DeleteCustomProtectionRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteCustomProtectionRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteCustomProtectionRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteCustomProtectionRule API.
DeleteWaasPolicy(DeleteWaasPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a policy.
Declaration
public Task<DeleteWaasPolicyResponse> DeleteWaasPolicy(DeleteWaasPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteWaasPolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteWaasPolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteWaasPolicy API.
GetAddressList(GetAddressListRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the details of an address list.
Declaration
public Task<GetAddressListResponse> GetAddressList(GetAddressListRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAddressListRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetAddressListResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAddressList API.
GetCertificate(GetCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the details of an SSL certificate.
Declaration
public Task<GetCertificateResponse> GetCertificate(GetCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCertificateRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetCertificateResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCertificate API.
GetCustomProtectionRule(GetCustomProtectionRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the details of a custom protection rule.
Declaration
public Task<GetCustomProtectionRuleResponse> GetCustomProtectionRule(GetCustomProtectionRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCustomProtectionRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetCustomProtectionRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCustomProtectionRule API.
GetDeviceFingerprintChallenge(GetDeviceFingerprintChallengeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the device fingerprint challenge settings in the Web Application Firewall configuration for a WAAS policy.
Declaration
public Task<GetDeviceFingerprintChallengeResponse> GetDeviceFingerprintChallenge(GetDeviceFingerprintChallengeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDeviceFingerprintChallengeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetDeviceFingerprintChallengeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDeviceFingerprintChallenge API.
GetHumanInteractionChallenge(GetHumanInteractionChallengeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the human interaction challenge settings in the Web Application Firewall configuration for a WAAS policy.
Declaration
public Task<GetHumanInteractionChallengeResponse> GetHumanInteractionChallenge(GetHumanInteractionChallengeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetHumanInteractionChallengeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetHumanInteractionChallengeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetHumanInteractionChallenge API.
GetJsChallenge(GetJsChallengeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the JavaScript challenge settings in the Web Application Firewall configuration for a WAAS policy.
Declaration
public Task<GetJsChallengeResponse> GetJsChallenge(GetJsChallengeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetJsChallengeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetJsChallengeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetJsChallenge API.
GetPolicyConfig(GetPolicyConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the configuration of a WAAS policy.
Declaration
public Task<GetPolicyConfigResponse> GetPolicyConfig(GetPolicyConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPolicyConfigRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetPolicyConfigResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPolicyConfig API.
GetProtectionRule(GetProtectionRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the details of a protection rule in the Web Application Firewall configuration for a WAAS policy.
Declaration
public Task<GetProtectionRuleResponse> GetProtectionRule(GetProtectionRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetProtectionRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetProtectionRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetProtectionRule API.
GetProtectionSettings(GetProtectionSettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the protection settings in the Web Application Firewall configuration for a WAAS policy.
Declaration
public Task<GetProtectionSettingsResponse> GetProtectionSettings(GetProtectionSettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetProtectionSettingsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetProtectionSettingsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetProtectionSettings API.
GetWaasPolicy(GetWaasPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the details of a WAAS policy.
Declaration
public Task<GetWaasPolicyResponse> GetWaasPolicy(GetWaasPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWaasPolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetWaasPolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWaasPolicy API.
GetWafAddressRateLimiting(GetWafAddressRateLimitingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the address rate limiting settings of the Web Application Firewall configuration for a WAAS policy.
Declaration
public Task<GetWafAddressRateLimitingResponse> GetWafAddressRateLimiting(GetWafAddressRateLimitingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWafAddressRateLimitingRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetWafAddressRateLimitingResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWafAddressRateLimiting API.
GetWafConfig(GetWafConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the Web Application Firewall configuration details for a WAAS policy.
Declaration
public Task<GetWafConfigResponse> GetWafConfig(GetWafConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWafConfigRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetWafConfigResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWafConfig API.
GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the details of a specified work request.
Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWorkRequest API.
ListAccessRules(ListAccessRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the currently configured access rules for the Web Application Firewall configuration of a specified WAAS policy. The order of the access rules is important. The rules will be checked in the order they are specified and the first matching rule will be used.
Declaration
public Task<ListAccessRulesResponse> ListAccessRules(ListAccessRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAccessRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAccessRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAccessRules API.
ListAddressLists(ListAddressListsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of address lists that can be used in a WAAS policy.
Declaration
public Task<ListAddressListsResponse> ListAddressLists(ListAddressListsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAddressListsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAddressListsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAddressLists API.
ListCachingRules(ListCachingRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the currently configured caching rules for the Web Application Firewall configuration of a specified WAAS policy. The rules are processed in the order they are specified in and the first matching rule will be used when processing a request.
Declaration
public Task<ListCachingRulesResponse> ListCachingRules(ListCachingRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCachingRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCachingRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCachingRules API.
ListCaptchas(ListCaptchasRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the list of currently configured CAPTCHA challenges in the Web Application Firewall configuration of a WAAS policy. <br/> The order of the CAPTCHA challenges is important. The URL for each CAPTCHA will be checked in the order they are created.
Declaration
public Task<ListCaptchasResponse> ListCaptchas(ListCaptchasRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCaptchasRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCaptchasResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCaptchas API.
ListCertificates(ListCertificatesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of SSL certificates that can be used in a WAAS policy.
Declaration
public Task<ListCertificatesResponse> ListCertificates(ListCertificatesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCertificatesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCertificatesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCertificates API.
ListCustomProtectionRules(ListCustomProtectionRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of custom protection rules for the specified Web Application Firewall.
Declaration
public Task<ListCustomProtectionRulesResponse> ListCustomProtectionRules(ListCustomProtectionRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCustomProtectionRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCustomProtectionRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCustomProtectionRules API.
ListEdgeSubnets(ListEdgeSubnetsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Return the list of the tenant's edge node subnets. Use these CIDR blocks to restrict incoming traffic to your origin. These subnets are owned by OCI and forward traffic to customer origins. They are not associated with specific regions or compartments.
Declaration
public Task<ListEdgeSubnetsResponse> ListEdgeSubnets(ListEdgeSubnetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListEdgeSubnetsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListEdgeSubnetsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListEdgeSubnets API.
ListGoodBots(ListGoodBotsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the list of good bots defined in the Web Application Firewall configuration for a WAAS policy.
<br/>
The list is sorted by key
, in ascending order.
Declaration
public Task<ListGoodBotsResponse> ListGoodBots(ListGoodBotsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListGoodBotsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListGoodBotsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListGoodBots API.
ListProtectionRules(ListProtectionRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the list of available protection rules for a WAAS policy. Use the GetWafConfig
operation to view a list of currently configured protection rules for the Web Application Firewall, or use the ListRecommendations
operation to get a list of recommended protection rules for the Web Application Firewall.
The list is sorted by key
, in ascending order.
Declaration
public Task<ListProtectionRulesResponse> ListProtectionRules(ListProtectionRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListProtectionRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListProtectionRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListProtectionRules API.
ListRecommendations(ListRecommendationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the list of recommended Web Application Firewall protection rules.
<br/>
Use the POST /waasPolicies/{waasPolicyId}/actions/acceptWafConfigRecommendations
method to accept recommended Web Application Firewall protection rules. For more information, see WAF Protection Rules.
The list is sorted by key
, in ascending order.
Declaration
public Task<ListRecommendationsResponse> ListRecommendations(ListRecommendationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRecommendationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListRecommendationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRecommendations API.
ListThreatFeeds(ListThreatFeedsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the list of available web application threat intelligence feeds
and the actions set for each feed. The list is sorted by key
,
in ascending order.
Declaration
public Task<ListThreatFeedsResponse> ListThreatFeeds(ListThreatFeedsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListThreatFeedsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListThreatFeedsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListThreatFeeds API.
ListWaasPolicies(ListWaasPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of WAAS policies.
Declaration
public Task<ListWaasPoliciesResponse> ListWaasPolicies(ListWaasPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWaasPoliciesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWaasPoliciesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWaasPolicies API.
ListWaasPolicyCustomProtectionRules(ListWaasPolicyCustomProtectionRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the list of currently configured custom protection rules for a WAAS policy.
Declaration
public Task<ListWaasPolicyCustomProtectionRulesResponse> ListWaasPolicyCustomProtectionRules(ListWaasPolicyCustomProtectionRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWaasPolicyCustomProtectionRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWaasPolicyCustomProtectionRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWaasPolicyCustomProtectionRules API.
ListWafBlockedRequests(ListWafBlockedRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the number of blocked requests by a Web Application Firewall feature in five minute blocks, sorted by timeObserved
in ascending order (starting from oldest data).
Declaration
public Task<ListWafBlockedRequestsResponse> ListWafBlockedRequests(ListWafBlockedRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWafBlockedRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWafBlockedRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWafBlockedRequests API.
ListWafLogs(ListWafLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets structured Web Application Firewall event logs for a WAAS
policy. Sorted by the timeObserved
in ascending order (starting from the
oldest recorded event).
Declaration
public Task<ListWafLogsResponse> ListWafLogs(ListWafLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWafLogsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWafLogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWafLogs API.
ListWafRequests(ListWafRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the number of requests managed by a Web Application Firewall
over a specified period of time, including blocked requests. Sorted
by timeObserved
in ascending order (starting from oldest requests).
Declaration
public Task<ListWafRequestsResponse> ListWafRequests(ListWafRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWafRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWafRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWafRequests API.
ListWafTraffic(ListWafTrafficRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the Web Application Firewall traffic data for a WAAS policy.
Sorted by timeObserved
in ascending order (starting from oldest data).
Declaration
public Task<ListWafTrafficResponse> ListWafTraffic(ListWafTrafficRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWafTrafficRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWafTrafficResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWafTraffic API.
ListWhitelists(ListWhitelistsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the list of whitelists defined in the Web Application Firewall configuration for a WAAS policy.
Declaration
public Task<ListWhitelistsResponse> ListWhitelists(ListWhitelistsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWhitelistsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWhitelistsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWhitelists API.
ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of subnets (CIDR notation) from which the WAAS EDGE may make requests. The subnets are owned by OCI and forward traffic to your origins. Allow traffic from these subnets to your origins. They are not associated with specific regions or compartments.
Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequests API.
PurgeCache(PurgeCacheRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Performs a purge of the cache for each specified resource. If no resources are passed, the cache for the entire Web Application Firewall will be purged. For more information, see Caching Rules.
Declaration
public Task<PurgeCacheResponse> PurgeCache(PurgeCacheRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PurgeCacheRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PurgeCacheResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PurgeCache API.
UpdateAccessRules(UpdateAccessRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the list of access rules in the Web Application Firewall configuration for a specified WAAS policy. Access rules allow explicit actions to be defined and executed for requests that meet various conditions. A rule action can be set to allow, detect, or block requests. The detect setting allows the request to pass through the Web Application Firewall and is tagged with a DETECT
flag in the Web Application Firewall's log.
<br/>
This operation can create, delete, update, and/or reorder access rules depending on the structure of the request body.
<br/>
Access rules can be updated by changing the properties of the access rule object with the rule's key specified in the key field. Access rules can be reordered by changing the order of the access rules in the list when updating.
<br/>
Access rules can be created by adding a new access rule object to the list without a key
property specified. A key
will be generated for the new access rule upon update.
<br/>
Any existing access rules that are not specified with a key
in the list of access rules will be deleted upon update.
Declaration
public Task<UpdateAccessRulesResponse> UpdateAccessRules(UpdateAccessRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateAccessRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateAccessRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateAccessRules API.
UpdateAddressList(UpdateAddressListRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the details of an address list. Only the fields specified in the request body will be updated; all other properties will remain unchanged.
Declaration
public Task<UpdateAddressListResponse> UpdateAddressList(UpdateAddressListRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateAddressListRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateAddressListResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateAddressList API.
UpdateCachingRules(UpdateCachingRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the configuration for each specified caching rule.
<br/>
Caching rules WAF policies allow you to selectively cache content on Oracle Cloud Infrastructure's edge servers, such as webpages or certain file types. For more information about caching rules, see Caching Rules.
<br/>
This operation can create, delete, update, and/or reorder caching rules depending on the structure of the request body. Caching rules can be updated by changing the properties of the caching rule object with the rule's key specified in the key field. Any existing caching rules that are not specified with a key in the list of access rules will be deleted upon update.
<br/>
The order the caching rules are specified in is important. The rules are processed in the order they are specified and the first matching rule will be used when processing a request. Use ListCachingRules
to view a list of all available caching rules in a compartment.
Declaration
public Task<UpdateCachingRulesResponse> UpdateCachingRules(UpdateCachingRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateCachingRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateCachingRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateCachingRules API.
UpdateCaptchas(UpdateCaptchasRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the list of CAPTCHA challenges in the Web Application Firewall configuration for a WAAS policy.
This operation can create, update, or delete CAPTCHAs depending on the structure of the request body.
CAPTCHA challenges can be updated by changing the properties of the CAPTCHA object with the rule's key specified in the key field. CAPTCHA challenges can be reordered by changing the order of the CAPTCHA challenges in the list when updating.
<br/>
CAPTCHA challenges can be created by adding a new access rule object to the list without a key
property specified. A key
will be generated for the new CAPTCHA challenges upon update.
<br/>
Any existing CAPTCHA challenges that are not specified with a key
in the list of CAPTCHA challenges will be deleted upon update.
<br/>
Query parameters are allowed in CAPTCHA URL.
Declaration
public Task<UpdateCaptchasResponse> UpdateCaptchas(UpdateCaptchasRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateCaptchasRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateCaptchasResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateCaptchas API.
UpdateCertificate(UpdateCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
It is not possible to update a certificate, only create and delete. Therefore, this operation can only update the display name, freeform tags, and defined tags of a certificate.
Declaration
public Task<UpdateCertificateResponse> UpdateCertificate(UpdateCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateCertificateRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateCertificateResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateCertificate API.
UpdateCustomProtectionRule(UpdateCustomProtectionRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the configuration of a custom protection rule. Only the fields specified in the request body will be updated; all other properties will remain unchanged.
Declaration
public Task<UpdateCustomProtectionRuleResponse> UpdateCustomProtectionRule(UpdateCustomProtectionRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateCustomProtectionRuleRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateCustomProtectionRuleResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateCustomProtectionRule API.
UpdateDeviceFingerprintChallenge(UpdateDeviceFingerprintChallengeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the Device Fingerprint Challenge (DFC) settings in the Web Application Firewall configuration for a policy. The DFC generates a hashed signature of both virtual and real browsers based on 50+ attributes. These proprietary signatures are then leveraged for real-time correlation to identify and block malicious bots. <br/> The signature is based on a library of attributes detected via JavaScript listeners; the attributes include OS, screen resolution, fonts, UserAgent, IP address, etc. We are constantly making improvements and considering new libraries to include in our DFC build. We can also exclude attributes from the signature as needed. <br/> DFC collects attributes to generate a hashed signature about a client - if a fingerprint is not possible, then it will result in a block or alert action. Actions can be enforced across multiple devices if they share they have the same fingerprint.
Declaration
public Task<UpdateDeviceFingerprintChallengeResponse> UpdateDeviceFingerprintChallenge(UpdateDeviceFingerprintChallengeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDeviceFingerprintChallengeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateDeviceFingerprintChallengeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDeviceFingerprintChallenge API.
UpdateGoodBots(UpdateGoodBotsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the list of good bots in the Web Application Firewall configuration for a policy. Only the fields specified in the request body will be updated, all other configuration properties will remain unchanged. <br/> Good bots allows you to manage access for bots from known providers, such as Google or Baidu. For more information about good bots, see Bot Management.
Declaration
public Task<UpdateGoodBotsResponse> UpdateGoodBots(UpdateGoodBotsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateGoodBotsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateGoodBotsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateGoodBots API.
UpdateHumanInteractionChallenge(UpdateHumanInteractionChallengeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the Human Interaction Challenge (HIC) settings in the Web Application Firewall configuration for a WAAS policy. HIC is a countermeasure that allows the proxy to check the user's browser for various behaviors that distinguish a human presence from a bot.
Declaration
public Task<UpdateHumanInteractionChallengeResponse> UpdateHumanInteractionChallenge(UpdateHumanInteractionChallengeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateHumanInteractionChallengeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateHumanInteractionChallengeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateHumanInteractionChallenge API.
UpdateJsChallenge(UpdateJsChallengeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the JavaScript challenge settings in the Web Application Firewall configuration for a WAAS policy. JavaScript Challenge validates that the client can accept JavaScript with a binary decision. For more information, see Bot Management.
Declaration
public Task<UpdateJsChallengeResponse> UpdateJsChallenge(UpdateJsChallengeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateJsChallengeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateJsChallengeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateJsChallenge API.
UpdatePolicyConfig(UpdatePolicyConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the configuration for a WAAS policy. Only the fields specified in the request body will be updated; all other properties will remain unchanged.
Declaration
public Task<UpdatePolicyConfigResponse> UpdatePolicyConfig(UpdatePolicyConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdatePolicyConfigRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdatePolicyConfigResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdatePolicyConfig API.
UpdateProtectionRules(UpdateProtectionRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the action for each specified protection rule. Requests can either be allowed, blocked, or trigger an alert if they meet the parameters of an applied rule. For more information on protection rules, see WAF Protection Rules. This operation can update or disable protection rules depending on the structure of the request body. Protection rules can be updated by changing the properties of the protection rule object with the rule's key specified in the key field.
Declaration
public Task<UpdateProtectionRulesResponse> UpdateProtectionRules(UpdateProtectionRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateProtectionRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateProtectionRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateProtectionRules API.
UpdateProtectionSettings(UpdateProtectionSettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the protection settings in the Web Application Firewall configuration for a WAAS policy. Protection settings allow you define what action is taken when a request is blocked by the Web Application Firewall, such as returning a response code or block page. Only the fields specified in the request body will be updated; all other fields will remain unchanged.
Declaration
public Task<UpdateProtectionSettingsResponse> UpdateProtectionSettings(UpdateProtectionSettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateProtectionSettingsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateProtectionSettingsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateProtectionSettings API.
UpdateThreatFeeds(UpdateThreatFeedsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the action to take when a request's IP address matches an address in the specified threat intelligence feed. Threat intelligence feeds are compiled lists of IP addresses with malicious reputations based on internet intelligence. Only the threat feeds specified in the request body will be updated; all other threat feeds will remain unchanged.
Declaration
public Task<UpdateThreatFeedsResponse> UpdateThreatFeeds(UpdateThreatFeedsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateThreatFeedsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateThreatFeedsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateThreatFeeds API.
UpdateWaasPolicy(UpdateWaasPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the details of a WAAS policy, including origins and tags. Only the fields specified in the request body will be updated; all other properties will remain unchanged.
To update platform provided resources such as GoodBots
, ProtectionRules
, and ThreatFeeds
, first retrieve the list of available resources with the related list operation such as GetThreatFeeds
or GetProtectionRules
.
The returned list will contain objects with key
properties that can be used to update the resource during the UpdateWaasPolicy
request.
Declaration
public Task<UpdateWaasPolicyResponse> UpdateWaasPolicy(UpdateWaasPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateWaasPolicyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateWaasPolicyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateWaasPolicy API.
UpdateWaasPolicyCustomProtectionRules(UpdateWaasPolicyCustomProtectionRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the action for each specified custom protection rule. Only the DETECT
and BLOCK
actions can be set. Disabled rules should not be included in the list. For more information on protection rules, see WAF Protection Rules.
Declaration
public Task<UpdateWaasPolicyCustomProtectionRulesResponse> UpdateWaasPolicyCustomProtectionRules(UpdateWaasPolicyCustomProtectionRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateWaasPolicyCustomProtectionRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateWaasPolicyCustomProtectionRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateWaasPolicyCustomProtectionRules API.
UpdateWafAddressRateLimiting(UpdateWafAddressRateLimitingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the address rate limiting settings in the Web Application Firewall configuration for a policy. Rate limiting allows you to configure a threshold for the number of requests from a unique IP address for the given period. You can also define the response code for the requests from the same address that exceed the threshold.
Declaration
public Task<UpdateWafAddressRateLimitingResponse> UpdateWafAddressRateLimiting(UpdateWafAddressRateLimitingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateWafAddressRateLimitingRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateWafAddressRateLimitingResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateWafAddressRateLimiting API.
UpdateWafConfig(UpdateWafConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the Web Application Firewall configuration for a specified WAAS policy.
<br/>
To update platform provided resources such as GoodBots
, ProtectionRules
, and ThreatFeeds
,
first retrieve the list of available resources with the related list operation, such as
GetThreatFeeds
or GetProtectionRules
.
<br/>
The returned list will contain objects with key
properties that can be used to update the
resource during the UpdateWafConfig
request.
Declaration
public Task<UpdateWafConfigResponse> UpdateWafConfig(UpdateWafConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateWafConfigRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateWafConfigResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateWafConfig API.
UpdateWhitelists(UpdateWhitelistsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the list of IP addresses that bypass the Web Application Firewall for a WAAS policy. Supports single IP addresses, subnet masks (CIDR notation) and Address Lists.
<br/>
This operation can create, delete, update, and/or reorder whitelists depending on the structure of the request body.
<br/>
Whitelists can be updated by changing the properties of the whitelist object with the rule's key specified in the key
field. Whitelists can be reordered by changing the order of the whitelists in the list of objects when updating.
<br/>
Whitelists can be created by adding a new whitelist object to the list without a key
property specified. A key
will be generated for the new whitelist upon update.
<br/>
Whitelists can be deleted by removing the existing whitelist object from the list. Any existing whitelists that are not specified with a key
in the list of access rules will be deleted upon update.
Declaration
public Task<UpdateWhitelistsResponse> UpdateWhitelists(UpdateWhitelistsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateWhitelistsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateWhitelistsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateWhitelists API.