Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WaasClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • WaasClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new WaasClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): WaasClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: WaasWaiter

targetService

targetService: string = "Waas"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://waas.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

acceptRecommendations

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

    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](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/wafprotectionrules.htm). This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AcceptRecommendations API.

    Parameters

    Returns Promise<AcceptRecommendationsResponse>

    AcceptRecommendationsResponse

cancelWorkRequest

changeAddressListCompartment

changeCertificateCompartment

changeCustomProtectionRuleCompartment

changeWaasPolicyCompartment

close

  • close(): void

createAddressList

  • 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. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateAddressList API.

    Parameters

    Returns Promise<CreateAddressListResponse>

    CreateAddressListResponse

createCertificate

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

    For more information, see [WAF Settings](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/wafsettings.htm). This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateCertificate API.

    Parameters

    Returns Promise<CreateCertificateResponse>

    CreateCertificateResponse

createCustomProtectionRule

  • Creates a new custom protection rule in the specified compartment.

    Custom protection rules allow you to create rules in addition to the rulesets provided by the Web Application Firewall service, including rules from [ModSecurity](https://modsecurity.org/). The syntax for custom rules is based on the ModSecurity syntax. For more information about custom protection rules, see [Custom Protection Rules](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/customprotectionrules.htm). This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateCustomProtectionRule API.

    Parameters

    Returns Promise<CreateCustomProtectionRuleResponse>

    CreateCustomProtectionRuleResponse

createWaasPolicy

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

    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.

    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.

    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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm).

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

    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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

    *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. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateWaasPolicy API.

    Parameters

    Returns Promise<CreateWaasPolicyResponse>

    CreateWaasPolicyResponse

createWaiters

  • createWaiters(config?: common.WaiterConfiguration): WaasWaiter
  • Creates a new WaasWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns WaasWaiter

    The service waiters.

deleteAddressList

  • Deletes the address list from the compartment if it is not used. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteAddressList API.

    Parameters

    Returns Promise<DeleteAddressListResponse>

    DeleteAddressListResponse

deleteCertificate

  • Deletes an SSL certificate from the WAAS service. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteCertificate API.

    Parameters

    Returns Promise<DeleteCertificateResponse>

    DeleteCertificateResponse

deleteCustomProtectionRule

deleteWaasPolicy

getAddressList

  • Gets the details of an address list. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAddressList API.

    Parameters

    Returns Promise<GetAddressListResponse>

    GetAddressListResponse

getCertificate

  • Gets the details of an SSL certificate. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCertificate API.

    Parameters

    Returns Promise<GetCertificateResponse>

    GetCertificateResponse

getCustomProtectionRule

  • Gets the details of a custom protection rule. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCustomProtectionRule API.

    Parameters

    Returns Promise<GetCustomProtectionRuleResponse>

    GetCustomProtectionRuleResponse

getDeviceFingerprintChallenge

  • Gets the device fingerprint challenge settings in the Web Application Firewall configuration for a WAAS policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDeviceFingerprintChallenge API.

    Parameters

    Returns Promise<GetDeviceFingerprintChallengeResponse>

    GetDeviceFingerprintChallengeResponse

getHumanInteractionChallenge

  • Gets the human interaction challenge settings in the Web Application Firewall configuration for a WAAS policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetHumanInteractionChallenge API.

    Parameters

    Returns Promise<GetHumanInteractionChallengeResponse>

    GetHumanInteractionChallengeResponse

getJsChallenge

  • Gets the JavaScript challenge settings in the Web Application Firewall configuration for a WAAS policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetJsChallenge API.

    Parameters

    Returns Promise<GetJsChallengeResponse>

    GetJsChallengeResponse

getPolicyConfig

  • Gets the configuration of a WAAS policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPolicyConfig API.

    Parameters

    Returns Promise<GetPolicyConfigResponse>

    GetPolicyConfigResponse

getProtectionRule

  • Gets the details of a protection rule in the Web Application Firewall configuration for a WAAS policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetProtectionRule API.

    Parameters

    Returns Promise<GetProtectionRuleResponse>

    GetProtectionRuleResponse

getProtectionSettings

  • Gets the protection settings in the Web Application Firewall configuration for a WAAS policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetProtectionSettings API.

    Parameters

    Returns Promise<GetProtectionSettingsResponse>

    GetProtectionSettingsResponse

getWaasPolicy

  • Gets the details of a WAAS policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWaasPolicy API.

    Parameters

    Returns Promise<GetWaasPolicyResponse>

    GetWaasPolicyResponse

getWafAddressRateLimiting

  • Gets the address rate limiting settings of the Web Application Firewall configuration for a WAAS policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWafAddressRateLimiting API.

    Parameters

    Returns Promise<GetWafAddressRateLimitingResponse>

    GetWafAddressRateLimitingResponse

getWafConfig

  • Gets the Web Application Firewall configuration details for a WAAS policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWafConfig API.

    Parameters

    Returns Promise<GetWafConfigResponse>

    GetWafConfigResponse

getWaiters

getWorkRequest

  • Gets the details of a specified work request. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

listAccessRules

  • 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. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAccessRules API.

    Parameters

    Returns Promise<ListAccessRulesResponse>

    ListAccessRulesResponse

listAccessRulesRecordIterator

  • Creates a new async iterator which will iterate over the models.AccessRule objects contained in responses from the listAccessRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AccessRule>

listAccessRulesResponseIterator

listAddressLists

  • Gets a list of address lists that can be used in a WAAS policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAddressLists API.

    Parameters

    Returns Promise<ListAddressListsResponse>

    ListAddressListsResponse

listAddressListsRecordIterator

  • Creates a new async iterator which will iterate over the models.AddressListSummary objects contained in responses from the listAddressLists operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AddressListSummary>

listAddressListsResponseIterator

listAllAccessRules

  • NOTE: This function is deprecated in favor of listAccessRulesRecordIterator function. Creates a new async iterator which will iterate over the models.AccessRule objects contained in responses from the listAccessRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AccessRule>

listAllAccessRulesResponses

  • NOTE: This function is deprecated in favor of listAccessRulesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listAccessRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListAccessRulesResponse>

listAllAddressLists

  • NOTE: This function is deprecated in favor of listAddressListsRecordIterator function. Creates a new async iterator which will iterate over the models.AddressListSummary objects contained in responses from the listAddressLists operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AddressListSummary>

listAllAddressListsResponses

  • NOTE: This function is deprecated in favor of listAddressListsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listAddressLists operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListAddressListsResponse>

listAllCachingRules

  • NOTE: This function is deprecated in favor of listCachingRulesRecordIterator function. Creates a new async iterator which will iterate over the models.CachingRuleSummary objects contained in responses from the listCachingRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CachingRuleSummary>

listAllCachingRulesResponses

  • NOTE: This function is deprecated in favor of listCachingRulesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listCachingRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListCachingRulesResponse>

listAllCaptchas

  • NOTE: This function is deprecated in favor of listCaptchasRecordIterator function. Creates a new async iterator which will iterate over the models.Captcha objects contained in responses from the listCaptchas operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Captcha>

listAllCaptchasResponses

  • NOTE: This function is deprecated in favor of listCaptchasResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listCaptchas operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListCaptchasResponse>

listAllCertificates

  • NOTE: This function is deprecated in favor of listCertificatesRecordIterator function. Creates a new async iterator which will iterate over the models.CertificateSummary objects contained in responses from the listCertificates operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CertificateSummary>

listAllCertificatesResponses

  • NOTE: This function is deprecated in favor of listCertificatesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listCertificates operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListCertificatesResponse>

listAllCustomProtectionRules

  • NOTE: This function is deprecated in favor of listCustomProtectionRulesRecordIterator function. Creates a new async iterator which will iterate over the models.CustomProtectionRuleSummary objects contained in responses from the listCustomProtectionRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CustomProtectionRuleSummary>

listAllCustomProtectionRulesResponses

  • NOTE: This function is deprecated in favor of listCustomProtectionRulesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listCustomProtectionRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListCustomProtectionRulesResponse>

listAllEdgeSubnets

  • NOTE: This function is deprecated in favor of listEdgeSubnetsRecordIterator function. Creates a new async iterator which will iterate over the models.EdgeSubnet objects contained in responses from the listEdgeSubnets operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<EdgeSubnet>

listAllEdgeSubnetsResponses

  • NOTE: This function is deprecated in favor of listEdgeSubnetsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listEdgeSubnets operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListEdgeSubnetsResponse>

listAllGoodBots

  • NOTE: This function is deprecated in favor of listGoodBotsRecordIterator function. Creates a new async iterator which will iterate over the models.GoodBot objects contained in responses from the listGoodBots operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<GoodBot>

listAllGoodBotsResponses

  • NOTE: This function is deprecated in favor of listGoodBotsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listGoodBots operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListGoodBotsResponse>

listAllProtectionRules

  • NOTE: This function is deprecated in favor of listProtectionRulesRecordIterator function. Creates a new async iterator which will iterate over the models.ProtectionRule objects contained in responses from the listProtectionRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ProtectionRule>

listAllProtectionRulesResponses

  • NOTE: This function is deprecated in favor of listProtectionRulesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listProtectionRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListProtectionRulesResponse>

listAllRecommendations

  • NOTE: This function is deprecated in favor of listRecommendationsRecordIterator function. Creates a new async iterator which will iterate over the models.Recommendation objects contained in responses from the listRecommendations operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Recommendation>

listAllRecommendationsResponses

  • NOTE: This function is deprecated in favor of listRecommendationsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listRecommendations operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListRecommendationsResponse>

listAllThreatFeeds

  • NOTE: This function is deprecated in favor of listThreatFeedsRecordIterator function. Creates a new async iterator which will iterate over the models.ThreatFeed objects contained in responses from the listThreatFeeds operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ThreatFeed>

listAllThreatFeedsResponses

  • NOTE: This function is deprecated in favor of listThreatFeedsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listThreatFeeds operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListThreatFeedsResponse>

listAllWaasPolicies

  • NOTE: This function is deprecated in favor of listWaasPoliciesRecordIterator function. Creates a new async iterator which will iterate over the models.WaasPolicySummary objects contained in responses from the listWaasPolicies operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WaasPolicySummary>

listAllWaasPoliciesResponses

  • NOTE: This function is deprecated in favor of listWaasPoliciesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWaasPolicies operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWaasPoliciesResponse>

listAllWaasPolicyCustomProtectionRules

  • NOTE: This function is deprecated in favor of listWaasPolicyCustomProtectionRulesRecordIterator function. Creates a new async iterator which will iterate over the models.WaasPolicyCustomProtectionRuleSummary objects contained in responses from the listWaasPolicyCustomProtectionRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WaasPolicyCustomProtectionRuleSummary>

listAllWaasPolicyCustomProtectionRulesResponses

listAllWafBlockedRequests

  • NOTE: This function is deprecated in favor of listWafBlockedRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.WafBlockedRequest objects contained in responses from the listWafBlockedRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WafBlockedRequest>

listAllWafBlockedRequestsResponses

  • NOTE: This function is deprecated in favor of listWafBlockedRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWafBlockedRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWafBlockedRequestsResponse>

listAllWafLogs

  • NOTE: This function is deprecated in favor of listWafLogsRecordIterator function. Creates a new async iterator which will iterate over the models.WafLog objects contained in responses from the listWafLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WafLog>

listAllWafLogsResponses

  • NOTE: This function is deprecated in favor of listWafLogsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWafLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWafLogsResponse>

listAllWafRequests

  • NOTE: This function is deprecated in favor of listWafRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.WafRequest objects contained in responses from the listWafRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WafRequest>

listAllWafRequestsResponses

  • NOTE: This function is deprecated in favor of listWafRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWafRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWafRequestsResponse>

listAllWafTraffic

  • NOTE: This function is deprecated in favor of listWafTrafficRecordIterator function. Creates a new async iterator which will iterate over the models.WafTrafficDatum objects contained in responses from the listWafTraffic operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WafTrafficDatum>

listAllWafTrafficResponses

  • NOTE: This function is deprecated in favor of listWafTrafficResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWafTraffic operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWafTrafficResponse>

listAllWhitelists

  • NOTE: This function is deprecated in favor of listWhitelistsRecordIterator function. Creates a new async iterator which will iterate over the models.Whitelist objects contained in responses from the listWhitelists operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Whitelist>

listAllWhitelistsResponses

  • NOTE: This function is deprecated in favor of listWhitelistsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWhitelists operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWhitelistsResponse>

listAllWorkRequests

  • NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listAllWorkRequestsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestsResponse>

listCachingRules

  • 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. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCachingRules API.

    Parameters

    Returns Promise<ListCachingRulesResponse>

    ListCachingRulesResponse

listCachingRulesRecordIterator

  • Creates a new async iterator which will iterate over the models.CachingRuleSummary objects contained in responses from the listCachingRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CachingRuleSummary>

listCachingRulesResponseIterator

listCaptchas

  • Gets the list of currently configured CAPTCHA challenges in the Web Application Firewall configuration of a WAAS policy.

    The order of the CAPTCHA challenges is important. The URL for each CAPTCHA will be checked in the order they are created.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCaptchas API.

    Parameters

    Returns Promise<ListCaptchasResponse>

    ListCaptchasResponse

listCaptchasRecordIterator

  • Creates a new async iterator which will iterate over the models.Captcha objects contained in responses from the listCaptchas operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Captcha>

listCaptchasResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listCaptchas operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListCaptchasResponse>

listCertificates

  • Gets a list of SSL certificates that can be used in a WAAS policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCertificates API.

    Parameters

    Returns Promise<ListCertificatesResponse>

    ListCertificatesResponse

listCertificatesRecordIterator

  • Creates a new async iterator which will iterate over the models.CertificateSummary objects contained in responses from the listCertificates operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CertificateSummary>

listCertificatesResponseIterator

listCustomProtectionRules

  • Gets a list of custom protection rules for the specified Web Application Firewall. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCustomProtectionRules API.

    Parameters

    Returns Promise<ListCustomProtectionRulesResponse>

    ListCustomProtectionRulesResponse

listCustomProtectionRulesRecordIterator

listCustomProtectionRulesResponseIterator

listEdgeSubnets

  • 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. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListEdgeSubnets API.

    Parameters

    Returns Promise<ListEdgeSubnetsResponse>

    ListEdgeSubnetsResponse

listEdgeSubnetsRecordIterator

  • Creates a new async iterator which will iterate over the models.EdgeSubnet objects contained in responses from the listEdgeSubnets operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<EdgeSubnet>

listEdgeSubnetsResponseIterator

listGoodBots

  • Gets the list of good bots defined in the Web Application Firewall configuration for a WAAS policy.

    The list is sorted by `key`, in ascending order.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListGoodBots API.

    Parameters

    Returns Promise<ListGoodBotsResponse>

    ListGoodBotsResponse

listGoodBotsRecordIterator

  • Creates a new async iterator which will iterate over the models.GoodBot objects contained in responses from the listGoodBots operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<GoodBot>

listGoodBotsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listGoodBots operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListGoodBotsResponse>

listProtectionRules

  • 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. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListProtectionRules API.

    Parameters

    Returns Promise<ListProtectionRulesResponse>

    ListProtectionRulesResponse

listProtectionRulesRecordIterator

  • Creates a new async iterator which will iterate over the models.ProtectionRule objects contained in responses from the listProtectionRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ProtectionRule>

listProtectionRulesResponseIterator

listRecommendations

  • Gets the list of recommended Web Application Firewall protection rules.

    Use the `POST /waasPolicies/{waasPolicyId}/actions/acceptWafConfigRecommendations` method to accept recommended Web Application Firewall protection rules. For more information, see [WAF Protection Rules](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/wafprotectionrules.htm). The list is sorted by `key`, in ascending order. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListRecommendations API.

    Parameters

    Returns Promise<ListRecommendationsResponse>

    ListRecommendationsResponse

listRecommendationsRecordIterator

  • Creates a new async iterator which will iterate over the models.Recommendation objects contained in responses from the listRecommendations operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Recommendation>

listRecommendationsResponseIterator

listThreatFeeds

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListThreatFeeds API.

    Parameters

    Returns Promise<ListThreatFeedsResponse>

    ListThreatFeedsResponse

listThreatFeedsRecordIterator

  • Creates a new async iterator which will iterate over the models.ThreatFeed objects contained in responses from the listThreatFeeds operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ThreatFeed>

listThreatFeedsResponseIterator

listWaasPolicies

  • Gets a list of WAAS policies. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWaasPolicies API.

    Parameters

    Returns Promise<ListWaasPoliciesResponse>

    ListWaasPoliciesResponse

listWaasPoliciesRecordIterator

  • Creates a new async iterator which will iterate over the models.WaasPolicySummary objects contained in responses from the listWaasPolicies operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WaasPolicySummary>

listWaasPoliciesResponseIterator

listWaasPolicyCustomProtectionRules

listWaasPolicyCustomProtectionRulesRecordIterator

listWaasPolicyCustomProtectionRulesResponseIterator

listWafBlockedRequests

  • 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). This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWafBlockedRequests API.

    Parameters

    Returns Promise<ListWafBlockedRequestsResponse>

    ListWafBlockedRequestsResponse

listWafBlockedRequestsRecordIterator

  • Creates a new async iterator which will iterate over the models.WafBlockedRequest objects contained in responses from the listWafBlockedRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WafBlockedRequest>

listWafBlockedRequestsResponseIterator

listWafLogs

  • Gets structured Web Application Firewall event logs for a WAAS policy. Sorted by the timeObserved in ascending order (starting from the oldest recorded event).

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWafLogs API.

    Parameters

    Returns Promise<ListWafLogsResponse>

    ListWafLogsResponse

listWafLogsRecordIterator

  • Creates a new async iterator which will iterate over the models.WafLog objects contained in responses from the listWafLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WafLog>

listWafLogsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listWafLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWafLogsResponse>

listWafRequests

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWafRequests API.

    Parameters

    Returns Promise<ListWafRequestsResponse>

    ListWafRequestsResponse

listWafRequestsRecordIterator

  • Creates a new async iterator which will iterate over the models.WafRequest objects contained in responses from the listWafRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WafRequest>

listWafRequestsResponseIterator

listWafTraffic

  • Gets the Web Application Firewall traffic data for a WAAS policy. Sorted by timeObserved in ascending order (starting from oldest data).

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWafTraffic API.

    Parameters

    Returns Promise<ListWafTrafficResponse>

    ListWafTrafficResponse

listWafTrafficRecordIterator

  • Creates a new async iterator which will iterate over the models.WafTrafficDatum objects contained in responses from the listWafTraffic operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WafTrafficDatum>

listWafTrafficResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listWafTraffic operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWafTrafficResponse>

listWhitelists

  • Gets the list of whitelists defined in the Web Application Firewall configuration for a WAAS policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWhitelists API.

    Parameters

    Returns Promise<ListWhitelistsResponse>

    ListWhitelistsResponse

listWhitelistsRecordIterator

  • Creates a new async iterator which will iterate over the models.Whitelist objects contained in responses from the listWhitelists operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Whitelist>

listWhitelistsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listWhitelists operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWhitelistsResponse>

listWorkRequests

  • 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. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

listWorkRequestsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listWorkRequestsResponseIterator

purgeCache

  • 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. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use PurgeCache API.

    Parameters

    Returns Promise<PurgeCacheResponse>

    PurgeCacheResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateAccessRules

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

    This operation can create, delete, update, and/or reorder access rules depending on the structure of the request body.

    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.

    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.

    Any existing access rules that are not specified with a `key` in the list of access rules will be deleted upon update. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateAccessRules API.

    Parameters

    Returns Promise<UpdateAccessRulesResponse>

    UpdateAccessRulesResponse

updateAddressList

  • Updates the details of an address list. Only the fields specified in the request body will be updated; all other properties will remain unchanged. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateAddressList API.

    Parameters

    Returns Promise<UpdateAddressListResponse>

    UpdateAddressListResponse

updateCachingRules

  • Updates the configuration for each specified caching rule.

    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](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/cachingrules.htm).

    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.

    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. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateCachingRules API.

    Parameters

    Returns Promise<UpdateCachingRulesResponse>

    UpdateCachingRulesResponse

updateCaptchas

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

    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.

    Any existing CAPTCHA challenges that are not specified with a `key` in the list of CAPTCHA challenges will be deleted upon update.

    Query parameters are allowed in CAPTCHA URL. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateCaptchas API.

    Parameters

    Returns Promise<UpdateCaptchasResponse>

    UpdateCaptchasResponse

updateCertificate

  • 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. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateCertificate API.

    Parameters

    Returns Promise<UpdateCertificateResponse>

    UpdateCertificateResponse

updateCustomProtectionRule

  • 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. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateCustomProtectionRule API.

    Parameters

    Returns Promise<UpdateCustomProtectionRuleResponse>

    UpdateCustomProtectionRuleResponse

updateDeviceFingerprintChallenge

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

    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.

    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. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDeviceFingerprintChallenge API.

    Parameters

    Returns Promise<UpdateDeviceFingerprintChallengeResponse>

    UpdateDeviceFingerprintChallengeResponse

updateGoodBots

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

    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](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/botmanagement.htm). This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateGoodBots API.

    Parameters

    Returns Promise<UpdateGoodBotsResponse>

    UpdateGoodBotsResponse

updateHumanInteractionChallenge

  • 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. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateHumanInteractionChallenge API.

    Parameters

    Returns Promise<UpdateHumanInteractionChallengeResponse>

    UpdateHumanInteractionChallengeResponse

updateJsChallenge

  • 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. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateJsChallenge API.

    Parameters

    Returns Promise<UpdateJsChallengeResponse>

    UpdateJsChallengeResponse

updatePolicyConfig

  • Updates the configuration for a WAAS policy. Only the fields specified in the request body will be updated; all other properties will remain unchanged. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdatePolicyConfig API.

    Parameters

    Returns Promise<UpdatePolicyConfigResponse>

    UpdatePolicyConfigResponse

updateProtectionRules

  • 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. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateProtectionRules API.

    Parameters

    Returns Promise<UpdateProtectionRulesResponse>

    UpdateProtectionRulesResponse

updateProtectionSettings

  • 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. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateProtectionSettings API.

    Parameters

    Returns Promise<UpdateProtectionSettingsResponse>

    UpdateProtectionSettingsResponse

updateThreatFeeds

  • 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. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateThreatFeeds API.

    Parameters

    Returns Promise<UpdateThreatFeedsResponse>

    UpdateThreatFeedsResponse

updateWaasPolicy

  • 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. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateWaasPolicy API.

    Parameters

    Returns Promise<UpdateWaasPolicyResponse>

    UpdateWaasPolicyResponse

updateWaasPolicyCustomProtectionRules

updateWafAddressRateLimiting

  • 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. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateWafAddressRateLimiting API.

    Parameters

    Returns Promise<UpdateWafAddressRateLimitingResponse>

    UpdateWafAddressRateLimitingResponse

updateWafConfig

  • Updates the Web Application Firewall configuration for a specified WAAS policy.

    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 `UpdateWafConfig` request.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateWafConfig API.

    Parameters

    Returns Promise<UpdateWafConfigResponse>

    UpdateWafConfigResponse

updateWhitelists

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

    This operation can create, delete, update, and/or reorder whitelists depending on the structure of the request body.

    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.

    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.

    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. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateWhitelists API.

    Parameters

    Returns Promise<UpdateWhitelistsResponse>

    UpdateWhitelistsResponse