Show / Hide Table of Contents

Namespace Oci.WaasService.Models

Classes

AccessRule

A content access rule. An access rule specifies an action to take if a set of criteria is matched by a request.

AccessRuleCriteria

When defined, the parent challenge would be applied only for the requests that matched all the listed conditions.

AddHttpResponseHeaderAction

An object that represents the action of replacing or adding a header field. All prior occurrences of the header with the given name are removed and then the header field with specified value is added.

AddressList

The details of the address list.

AddressListSummary

A summary of the address list's information.

AddressRateLimiting

The IP rate limiting configuration. Defines the amount of allowed requests from a unique IP address and the resulting block response code when that threshold is exceeded.

BlockChallengeSettings

The challenge settings if action is set to BLOCK.

CachingRule

CachingRuleCriteria

A caching rule criteria condition and value.

CachingRuleSummary

The caching rule settings.

Captcha

The settings of the CAPTCHA challenge. If a specific URL should be accessed only by a human, a CAPTCHA challenge can be placed at the URL to protect the web application from bots.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Certificate

The details of the SSL certificate. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

CertificateIssuerName

The issuer of the certificate.

CertificateSubjectName

The entity to be secured by the certificate.

CertificateSummary

A summary of the SSL certificate's information. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Certificate_extensions

Certificate_publicKeyInfo

Information about the public key and the algorithm used by the public key.

ChangeAddressListCompartmentDetails

ChangeCertificateCompartmentDetails

ChangeCustomProtectionRuleCompartmentDetails

ChangeHttpRedirectCompartmentDetails

ChangeWaasPolicyCompartmentDetails

CreateAddressListDetails

The data used to create a new address list of IP addresses and CIDR notations.

CreateCertificateDetails

The data used to create a new SSL certificate.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

CreateCustomProtectionRuleDetails

The required data to create a custom protection rule. For more information about custom protection rules, see Custom Protection Rules. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

CreateHttpRedirectDetails

The details of a HTTP Redirect configured to redirect traffic from one hostname to another. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

CreateWaasPolicyDetails

The required data to create a WAAS policy.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

CustomProtectionRule

The details of a custom protection rule.

CustomProtectionRuleSetting

The OCID and action of a custom protection rule.

CustomProtectionRuleSummary

An overview of a custom protection rule.

DeviceFingerprintChallenge

The device fingerprint challenge settings. The device fingerprint challenge generates hashed signatures of both virtual and real browsers to identify and block malicious bots.

EdgeSubnet

The details about an edge node subnet.

ExtendHttpResponseHeaderAction

An object that represents the action of adding a header field to a response. If the header with specified value already exists, nothing will be added. If the header exists with different value, additional header name:value pair will be added. Comma separated header values are not considered individually (instead as a single value) when adding a new header field.

GoodBot

The good bot settings. Good bots provides a list of bots which are managed by known providers.

Header

An HTTP header with name and value.

HeaderManipulationAction

An object that represents an action to apply to an HTTP headers.

HeaderManipulationActionModelConverter

HealthCheck

Health checks monitor the status of your origin servers and only route traffic to the origins that pass the health check. If the health check fails, origin is automatically removed from the load balancing. There is roughly one health check per EDGE POP per period. Any checks that pass will be reported as "healthy".

HttpRedirect

The details of a HTTP Redirect configuration to allow redirecting HTTP traffic from a request domain to a new target.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

HttpRedirectSummary

The details of a HTTP Redirect configuration to allow redirecting HTTP traffic from a request domain to a new target.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

HttpRedirectTarget

HumanInteractionChallenge

The human interaction challenge settings. The human interaction challenge checks various event listeners in the user's browser to determine if there is a human user making a request.

IPHashLoadBalancingMethod

An object that represents the ip-hash load balancing method.

JsChallenge

The JavaScript challenge settings. JavaScript Challenge is the function to filter abnormal or malicious bots and allow access to real clients.

LoadBalancingMethod

LoadBalancingMethodModelConverter

Origin

A detailed description of your web application's origin host server. An origin must be defined to set up WAF rules.

OriginGroup

OriginGroup_origins

PolicyConfig

The configuration details for the WAAS policy.

ProtectionRule

The protection rule settings. Protection rules can allow, block, or trigger an alert if a request meets the parameters of an applied rule.

ProtectionRuleAction

A protection rule key and the associated action to apply to that rule.

ProtectionRuleExclusion

Allows specified types of requests to bypass the protection rule. If a request matches any of the criteria in the exclusions field, the protection rule will not be executed. Rules can have more than one exclusion and exclusions are applied to requests disjunctively, meaning the specified exclusion strings are independently matched against the specified targets of a request. The first target to match a specified string will trigger an exclusion. **Example: ** If the following exclusions are defined for a protection rule: "action": "BLOCK", "exclusions": [ { "target":"REQUEST_COOKIES", "exclusions":["example.com", "12345", "219ffwef9w0f"] }, { "target":"REQUEST_COOKIE_NAMES", "exclusions":["OAMAuthnCookie", "JSESSIONID", "HCM-PSJSESSIONID"] } ], "key": "1000000",A request with the cookie name sessionid would trigger an exclusion. A request with the cookie name yourcompany.com would not trigger and exclusion.

ProtectionSettings

The settings used for protection rules.

PurgeCache

The list of cached resources to purge. If a resource is not specified, the purge targets all rules in a policy.

Recommendation

A recommended protection rule for a web application. This recommendation can be accepted to apply it to the Web Application Firewall configuration for this policy.
Use the POST /waasPolicies/{waasPolicyId}/actions/acceptWafConfigRecommendations method to accept recommended protection rules.

RemoveHttpResponseHeaderAction

An object that represents the action of removing from a response all occurrences of header fields with a specified name.

RoundRobinLoadBalancingMethod

An object that represents the round-robin load balancing method.

StickyCookieLoadBalancingMethod

An object that represents the sticky-cookie load balancing method and its properties.

ThreatFeed

The settings of the threat intelligence feed. You can block requests from IP addresses based on their reputations with various commercial and open source threat feeds.

ThreatFeedAction

The action to take for a request that has been determined to be potentially malicious.

UpdateAddressListDetails

The data used to update the address list: IP addresses and CIDR notations.

UpdateCertificateDetails

The data used to create a new SSL certificate.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

UpdateCustomProtectionRuleDetails

Updates the configuration details of a custom protection rule. Custom protection rules can only be updated if they are not active in a WAAS policy. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

UpdateHttpRedirectDetails

The details of a HTTP Redirect configured to redirect traffic from one hostname to another.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

UpdateWaasPolicyDetails

Updates the configuration details of a WAAS policy.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

WaasPolicy

The details of a Web Application Acceleration and Security (WAAS) policy. A policy describes how the WAAS service should operate for the configured web application.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

WaasPolicyCustomProtectionRuleSummary

The OCID and action of a custom protection rule.

WaasPolicySummary

Summary information about a WAAS policy.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

WafBlockedRequest

WafConfig

The Web Application Firewall configuration for the WAAS policy.

WafConfigDetails

The Web Application Firewall configuration for the WAAS policy creation.

WafLog

A list of Web Application Firewall log entries. Each entry is a JSON object, including a timestamp property and other fields varying based on log type. Logs record what rules and countermeasures are triggered by requests and are used as a basis to move request handling into block mode. For more information about WAF logs, see Logs.

WafMeterDatum

WafRequest

A time series of request counts handled by the Web Application Firewall, including blocked requests.

WafTrafficDatum

A time series of traffic data for the Web Application Firewall configured for a policy.

Whitelist

An array of IP addresses that bypass the Web Application Firewall. Supports both single IP addresses or subnet masks (CIDR notation).

WorkRequest

Many of the API requests you use to create and configure WAAS policies do not take effect immediately. In these cases, the request spawns an asynchronous work flow to fulfill the request. WorkRequest objects provide visibility for in-progress work flows. For more information about work requests, see Viewing the State of a Work Request.

WorkRequestError

An object returned in the event of a work request error.

WorkRequestLogEntry

A log message for a work request.

WorkRequestResource

The resource on which the work request is operating.

WorkRequestSummary

The summarized details of a work request.

Enums

AccessRule.ActionEnum

AccessRule.BlockActionEnum

AccessRule.BypassChallengesEnum

AccessRule.RedirectResponseCodeEnum

AccessRuleCriteria.ConditionEnum

BlockChallengeSettings.BlockActionEnum

CachingRule.ActionEnum

CachingRuleCriteria.ConditionEnum

CachingRuleSummary.ActionEnum

CustomProtectionRuleSetting.ActionEnum

DeviceFingerprintChallenge.ActionEnum

HeaderManipulationAction.ActionEnum

HealthCheck.ExpectedResponseCodeGroupEnum

HealthCheck.MethodEnum

HttpRedirectTarget.ProtocolEnum

HumanInteractionChallenge.ActionEnum

JsChallenge.ActionEnum

LifecycleStates

The current status of the specified WAAS policy.

LoadBalancingMethod.MethodEnum

PolicyConfig.CipherGroupEnum

PolicyConfig.ClientAddressHeaderEnum

PolicyConfig.TlsProtocolsEnum

ProtectionRule.ActionEnum

ProtectionRuleAction.ActionEnum

ProtectionRuleExclusion.TargetEnum

ProtectionSettings.AllowedHttpMethodsEnum

ProtectionSettings.BlockActionEnum

ThreatFeed.ActionEnum

ThreatFeedAction.ActionEnum

WaasPolicyCustomProtectionRuleSummary.ActionEnum

WafBlockedRequest.WafFeatureEnum

WorkRequestOperationTypes

An enum value indicating the operation being performed by the work request.

WorkRequestResource.ActionTypeEnum

WorkRequestStatusValues

The possible status values for a work request.

In this article
Back to top