oci-waas 2.76.1 → 2.77.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/client.d.ts +72 -72
- package/lib/client.js +72 -72
- package/lib/model/access-rule-criteria.d.ts +25 -25
- package/lib/model/access-rule.d.ts +15 -15
- package/lib/model/add-http-response-header-action.d.ts +2 -2
- package/lib/model/address-list-summary.d.ts +2 -2
- package/lib/model/address-list.d.ts +2 -2
- package/lib/model/address-rate-limiting.d.ts +3 -3
- package/lib/model/block-challenge-settings.d.ts +10 -10
- package/lib/model/caching-rule-criteria.d.ts +5 -5
- package/lib/model/caching-rule-summary.d.ts +5 -5
- package/lib/model/caching-rule.d.ts +5 -5
- package/lib/model/captcha.d.ts +4 -4
- package/lib/model/certificate-summary.d.ts +2 -2
- package/lib/model/certificate.d.ts +3 -3
- package/lib/model/create-address-list-details.d.ts +2 -2
- package/lib/model/create-certificate-details.d.ts +4 -4
- package/lib/model/create-custom-protection-rule-details.d.ts +7 -7
- package/lib/model/create-http-redirect-details.d.ts +2 -2
- package/lib/model/create-waas-policy-details.d.ts +4 -4
- package/lib/model/custom-protection-rule-setting.d.ts +1 -1
- package/lib/model/custom-protection-rule-summary.d.ts +2 -2
- package/lib/model/custom-protection-rule.d.ts +7 -7
- package/lib/model/device-fingerprint-challenge.d.ts +6 -6
- package/lib/model/extend-http-response-header-action.d.ts +2 -2
- package/lib/model/health-check.d.ts +1 -1
- package/lib/model/http-redirect-summary.d.ts +2 -2
- package/lib/model/http-redirect.d.ts +2 -2
- package/lib/model/human-interaction-challenge.d.ts +7 -7
- package/lib/model/i-phash-load-balancing-method.d.ts +1 -1
- package/lib/model/js-challenge.d.ts +4 -4
- package/lib/model/origin.d.ts +3 -3
- package/lib/model/policy-config.d.ts +15 -15
- package/lib/model/protection-rule-action.d.ts +2 -2
- package/lib/model/protection-rule-exclusion.d.ts +2 -2
- package/lib/model/protection-rule.d.ts +2 -2
- package/lib/model/protection-settings.d.ts +18 -18
- package/lib/model/purge-cache.d.ts +1 -1
- package/lib/model/recommendation.d.ts +1 -1
- package/lib/model/remove-http-response-header-action.d.ts +1 -1
- package/lib/model/round-robin-load-balancing-method.d.ts +1 -1
- package/lib/model/sticky-cookie-load-balancing-method.d.ts +1 -1
- package/lib/model/threat-feed-action.d.ts +1 -1
- package/lib/model/threat-feed.d.ts +1 -1
- package/lib/model/update-address-list-details.d.ts +2 -2
- package/lib/model/update-certificate-details.d.ts +2 -2
- package/lib/model/update-custom-protection-rule-details.d.ts +7 -7
- package/lib/model/update-http-redirect-details.d.ts +2 -2
- package/lib/model/update-waas-policy-details.d.ts +4 -4
- package/lib/model/waas-policy-custom-protection-rule-summary.d.ts +1 -1
- package/lib/model/waas-policy-summary.d.ts +2 -2
- package/lib/model/waas-policy.d.ts +4 -4
- package/lib/model/waf-config-details.d.ts +4 -4
- package/lib/model/waf-config.d.ts +4 -4
- package/lib/model/waf-log.d.ts +14 -14
- package/lib/model/waf-meter-datum.d.ts +1 -1
- package/lib/model/work-request-resource.d.ts +1 -1
- package/lib/model/work-request-summary.d.ts +1 -1
- package/lib/model/work-request.d.ts +2 -2
- package/lib/request/accept-recommendations-request.d.ts +2 -2
- package/lib/request/cancel-work-request-request.d.ts +2 -2
- package/lib/request/change-address-list-compartment-request.d.ts +2 -2
- package/lib/request/change-certificate-compartment-request.d.ts +2 -2
- package/lib/request/change-custom-protection-rule-compartment-request.d.ts +2 -2
- package/lib/request/change-http-redirect-compartment-request.d.ts +2 -2
- package/lib/request/change-waas-policy-compartment-request.d.ts +2 -2
- package/lib/request/create-address-list-request.d.ts +1 -1
- package/lib/request/create-certificate-request.d.ts +1 -1
- package/lib/request/create-custom-protection-rule-request.d.ts +1 -1
- package/lib/request/create-http-redirect-request.d.ts +1 -1
- package/lib/request/create-waas-policy-request.d.ts +1 -1
- package/lib/request/delete-address-list-request.d.ts +2 -2
- package/lib/request/delete-certificate-request.d.ts +2 -2
- package/lib/request/delete-custom-protection-rule-request.d.ts +2 -2
- package/lib/request/delete-http-redirect-request.d.ts +2 -2
- package/lib/request/delete-waas-policy-request.d.ts +2 -2
- package/lib/request/get-address-list-request.d.ts +1 -1
- package/lib/request/get-certificate-request.d.ts +1 -1
- package/lib/request/get-custom-protection-rule-request.d.ts +1 -1
- package/lib/request/get-device-fingerprint-challenge-request.d.ts +1 -1
- package/lib/request/get-http-redirect-request.d.ts +1 -1
- package/lib/request/get-human-interaction-challenge-request.d.ts +1 -1
- package/lib/request/get-js-challenge-request.d.ts +1 -1
- package/lib/request/get-policy-config-request.d.ts +1 -1
- package/lib/request/get-protection-rule-request.d.ts +1 -1
- package/lib/request/get-protection-settings-request.d.ts +1 -1
- package/lib/request/get-waas-policy-request.d.ts +1 -1
- package/lib/request/get-waf-address-rate-limiting-request.d.ts +1 -1
- package/lib/request/get-waf-config-request.d.ts +1 -1
- package/lib/request/get-work-request-request.d.ts +1 -1
- package/lib/request/list-access-rules-request.d.ts +3 -3
- package/lib/request/list-address-lists-request.d.ts +5 -5
- package/lib/request/list-caching-rules-request.d.ts +3 -3
- package/lib/request/list-captchas-request.d.ts +3 -3
- package/lib/request/list-certificates-request.d.ts +5 -5
- package/lib/request/list-custom-protection-rules-request.d.ts +5 -5
- package/lib/request/list-edge-subnets-request.d.ts +5 -5
- package/lib/request/list-good-bots-request.d.ts +3 -3
- package/lib/request/list-http-redirects-request.d.ts +4 -4
- package/lib/request/list-protection-rules-request.d.ts +3 -3
- package/lib/request/list-recommendations-request.d.ts +3 -3
- package/lib/request/list-threat-feeds-request.d.ts +3 -3
- package/lib/request/list-waas-policies-request.d.ts +5 -5
- package/lib/request/list-waas-policy-custom-protection-rules-request.d.ts +3 -3
- package/lib/request/list-waf-blocked-requests-request.d.ts +3 -3
- package/lib/request/list-waf-logs-request.d.ts +3 -3
- package/lib/request/list-waf-requests-request.d.ts +3 -3
- package/lib/request/list-waf-traffic-request.d.ts +3 -3
- package/lib/request/list-whitelists-request.d.ts +3 -3
- package/lib/request/list-work-requests-request.d.ts +5 -5
- package/lib/request/purge-cache-request.d.ts +2 -2
- package/lib/request/update-access-rules-request.d.ts +2 -2
- package/lib/request/update-address-list-request.d.ts +2 -2
- package/lib/request/update-caching-rules-request.d.ts +2 -2
- package/lib/request/update-captchas-request.d.ts +2 -2
- package/lib/request/update-certificate-request.d.ts +2 -2
- package/lib/request/update-custom-protection-rule-request.d.ts +2 -2
- package/lib/request/update-device-fingerprint-challenge-request.d.ts +2 -2
- package/lib/request/update-good-bots-request.d.ts +2 -2
- package/lib/request/update-http-redirect-request.d.ts +2 -2
- package/lib/request/update-human-interaction-challenge-request.d.ts +2 -2
- package/lib/request/update-js-challenge-request.d.ts +2 -2
- package/lib/request/update-policy-config-request.d.ts +2 -2
- package/lib/request/update-protection-rules-request.d.ts +2 -2
- package/lib/request/update-protection-settings-request.d.ts +2 -2
- package/lib/request/update-threat-feeds-request.d.ts +2 -2
- package/lib/request/update-waas-policy-custom-protection-rules-request.d.ts +2 -2
- package/lib/request/update-waas-policy-request.d.ts +2 -2
- package/lib/request/update-waf-address-rate-limiting-request.d.ts +2 -2
- package/lib/request/update-waf-config-request.d.ts +2 -2
- package/lib/request/update-whitelists-request.d.ts +2 -2
- package/lib/response/create-address-list-response.d.ts +1 -1
- package/lib/response/create-certificate-response.d.ts +1 -1
- package/lib/response/create-custom-protection-rule-response.d.ts +1 -1
- package/lib/response/create-waas-policy-response.d.ts +1 -1
- package/lib/response/get-address-list-response.d.ts +1 -1
- package/lib/response/get-certificate-response.d.ts +1 -1
- package/lib/response/get-custom-protection-rule-response.d.ts +1 -1
- package/lib/response/get-device-fingerprint-challenge-response.d.ts +1 -1
- package/lib/response/get-http-redirect-response.d.ts +1 -1
- package/lib/response/get-human-interaction-challenge-response.d.ts +1 -1
- package/lib/response/get-js-challenge-response.d.ts +1 -1
- package/lib/response/get-policy-config-response.d.ts +1 -1
- package/lib/response/get-protection-rule-response.d.ts +1 -1
- package/lib/response/get-protection-settings-response.d.ts +1 -1
- package/lib/response/get-waas-policy-response.d.ts +1 -1
- package/lib/response/get-waf-address-rate-limiting-response.d.ts +1 -1
- package/lib/response/get-waf-config-response.d.ts +1 -1
- package/lib/response/get-work-request-response.d.ts +1 -1
- package/lib/response/list-access-rules-response.d.ts +1 -1
- package/lib/response/list-caching-rules-response.d.ts +1 -1
- package/lib/response/list-captchas-response.d.ts +1 -1
- package/lib/response/list-edge-subnets-response.d.ts +1 -1
- package/lib/response/list-good-bots-response.d.ts +1 -1
- package/lib/response/list-protection-rules-response.d.ts +1 -1
- package/lib/response/list-recommendations-response.d.ts +1 -1
- package/lib/response/list-threat-feeds-response.d.ts +1 -1
- package/lib/response/list-waas-policy-custom-protection-rules-response.d.ts +1 -1
- package/lib/response/list-whitelists-response.d.ts +1 -1
- package/lib/response/update-address-list-response.d.ts +1 -1
- package/lib/response/update-certificate-response.d.ts +1 -1
- package/lib/response/update-custom-protection-rule-response.d.ts +1 -1
- package/package.json +3 -3
|
@@ -40,7 +40,7 @@ export interface CreateHttpRedirectDetails {
|
|
|
40
40
|
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
|
|
41
41
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
42
42
|
* <p>
|
|
43
|
-
Example:
|
|
43
|
+
Example: {@code {\"Department\": \"Finance\"}}
|
|
44
44
|
*
|
|
45
45
|
*/
|
|
46
46
|
"freeformTags"?: {
|
|
@@ -50,7 +50,7 @@ export interface CreateHttpRedirectDetails {
|
|
|
50
50
|
* Defined tags for this resource. Each key is predefined and scoped to a namespace.
|
|
51
51
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
52
52
|
* <p>
|
|
53
|
-
Example:
|
|
53
|
+
Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
|
|
54
54
|
*
|
|
55
55
|
*/
|
|
56
56
|
"definedTags"?: {
|
|
@@ -40,8 +40,8 @@ export interface CreateWaasPolicyDetails {
|
|
|
40
40
|
[key: string]: model.Origin;
|
|
41
41
|
};
|
|
42
42
|
/**
|
|
43
|
-
* The map of origin groups and their keys used to associate origins to the
|
|
44
|
-
* To add additional origins to your WAAS policy, update the
|
|
43
|
+
* The map of origin groups and their keys used to associate origins to the {@code wafConfig}. Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests.
|
|
44
|
+
* To add additional origins to your WAAS policy, update the {@code origins} field of a {@code UpdateWaasPolicy} request.
|
|
45
45
|
*/
|
|
46
46
|
"originGroups"?: {
|
|
47
47
|
[key: string]: model.OriginGroup;
|
|
@@ -52,7 +52,7 @@ export interface CreateWaasPolicyDetails {
|
|
|
52
52
|
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
|
|
53
53
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
54
54
|
* <p>
|
|
55
|
-
Example:
|
|
55
|
+
Example: {@code {\"Department\": \"Finance\"}}
|
|
56
56
|
*
|
|
57
57
|
*/
|
|
58
58
|
"freeformTags"?: {
|
|
@@ -62,7 +62,7 @@ export interface CreateWaasPolicyDetails {
|
|
|
62
62
|
* Defined tags for this resource. Each key is predefined and scoped to a namespace.
|
|
63
63
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
64
64
|
* <p>
|
|
65
|
-
Example:
|
|
65
|
+
Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
|
|
66
66
|
*
|
|
67
67
|
*/
|
|
68
68
|
"definedTags"?: {
|
|
@@ -21,7 +21,7 @@ export interface CustomProtectionRuleSetting {
|
|
|
21
21
|
"id"?: string;
|
|
22
22
|
/**
|
|
23
23
|
* The action to take when the custom protection rule is triggered.
|
|
24
|
-
*
|
|
24
|
+
* {@code DETECT} - Logs the request when the criteria of the custom protection rule are met. {@code BLOCK} - Blocks the request when the criteria of the custom protection rule are met.
|
|
25
25
|
*/
|
|
26
26
|
"action"?: CustomProtectionRuleSetting.Action;
|
|
27
27
|
"exclusions"?: Array<model.ProtectionRuleExclusion>;
|
|
@@ -43,7 +43,7 @@ export interface CustomProtectionRuleSummary {
|
|
|
43
43
|
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
|
|
44
44
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
45
45
|
* <p>
|
|
46
|
-
Example:
|
|
46
|
+
Example: {@code {\"Department\": \"Finance\"}}
|
|
47
47
|
*
|
|
48
48
|
*/
|
|
49
49
|
"freeformTags"?: {
|
|
@@ -53,7 +53,7 @@ export interface CustomProtectionRuleSummary {
|
|
|
53
53
|
* Defined tags for this resource. Each key is predefined and scoped to a namespace.
|
|
54
54
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
55
55
|
* <p>
|
|
56
|
-
Example:
|
|
56
|
+
Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
|
|
57
57
|
*
|
|
58
58
|
*/
|
|
59
59
|
"definedTags"?: {
|
|
@@ -40,12 +40,12 @@ export interface CustomProtectionRule {
|
|
|
40
40
|
* <p>
|
|
41
41
|
Additionally, each rule must include two placeholder variables that are updated by the WAF service upon publication of the rule.
|
|
42
42
|
* <p>
|
|
43
|
-
|
|
43
|
+
{@code id: {{id_1}}} - This field is populated with a unique rule ID generated by the WAF service which identifies a {@code SecRule}. More than one {@code SecRule} can be defined in the {@code template} field of a CreateCustomSecurityRule call. The value of the first {@code SecRule} must be {@code id: {{id_1}}} and the {@code id} field of each subsequent {@code SecRule} should increase by one, as shown in the example.
|
|
44
44
|
* <p>
|
|
45
|
-
|
|
45
|
+
{@code ctl:ruleEngine={{mode}}} - The action to be taken when the criteria of the {@code SecRule} are met, either {@code OFF}, {@code DETECT} or {@code BLOCK}. This field is automatically populated with the corresponding value of the {@code action} field of the {@code CustomProtectionRuleSetting} schema when the {@code WafConfig} is updated.
|
|
46
46
|
* <p>
|
|
47
47
|
*Example:*
|
|
48
|
-
*
|
|
48
|
+
* {@code
|
|
49
49
|
* SecRule REQUEST_COOKIES \"regex matching SQL injection - part 1/2\" \\
|
|
50
50
|
* \"phase:2, \\
|
|
51
51
|
* msg:'Detects chained SQL injection attempts 1/2.', \\
|
|
@@ -58,10 +58,10 @@ export interface CustomProtectionRule {
|
|
|
58
58
|
* id: {{id_2}}, \\
|
|
59
59
|
* ctl:ruleEngine={{mode}}, \\
|
|
60
60
|
* deny\"
|
|
61
|
-
*
|
|
61
|
+
* }
|
|
62
62
|
* <p>
|
|
63
63
|
|
|
64
|
-
* The example contains two
|
|
64
|
+
* The example contains two {@code SecRules} each having distinct regex expression to match the {@code Cookie} header value during the second input analysis phase.
|
|
65
65
|
* <p>
|
|
66
66
|
For more information about custom protection rules, see [Custom Protection Rules](https://docs.cloud.oracle.com/Content/WAF/Tasks/customprotectionrules.htm).
|
|
67
67
|
* <p>
|
|
@@ -82,7 +82,7 @@ export interface CustomProtectionRule {
|
|
|
82
82
|
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
|
|
83
83
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
84
84
|
* <p>
|
|
85
|
-
Example:
|
|
85
|
+
Example: {@code {\"Department\": \"Finance\"}}
|
|
86
86
|
*
|
|
87
87
|
*/
|
|
88
88
|
"freeformTags"?: {
|
|
@@ -92,7 +92,7 @@ export interface CustomProtectionRule {
|
|
|
92
92
|
* Defined tags for this resource. Each key is predefined and scoped to a namespace.
|
|
93
93
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
94
94
|
* <p>
|
|
95
|
-
Example:
|
|
95
|
+
Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
|
|
96
96
|
*
|
|
97
97
|
*/
|
|
98
98
|
"definedTags"?: {
|
|
@@ -20,27 +20,27 @@ export interface DeviceFingerprintChallenge {
|
|
|
20
20
|
*/
|
|
21
21
|
"isEnabled": boolean;
|
|
22
22
|
/**
|
|
23
|
-
* The action to take on requests from detected bots. If unspecified, defaults to
|
|
23
|
+
* The action to take on requests from detected bots. If unspecified, defaults to {@code DETECT}.
|
|
24
24
|
*/
|
|
25
25
|
"action"?: DeviceFingerprintChallenge.Action;
|
|
26
26
|
/**
|
|
27
|
-
* The number of failed requests allowed before taking action. If unspecified, defaults to
|
|
27
|
+
* The number of failed requests allowed before taking action. If unspecified, defaults to {@code 10}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
28
28
|
*/
|
|
29
29
|
"failureThreshold"?: number;
|
|
30
30
|
/**
|
|
31
|
-
* The number of seconds between challenges for the same IP address. If unspecified, defaults to
|
|
31
|
+
* The number of seconds between challenges for the same IP address. If unspecified, defaults to {@code 60}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
32
32
|
*/
|
|
33
33
|
"actionExpirationInSeconds"?: number;
|
|
34
34
|
/**
|
|
35
|
-
* The number of seconds before the failure threshold resets. If unspecified, defaults to
|
|
35
|
+
* The number of seconds before the failure threshold resets. If unspecified, defaults to {@code 60}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
36
36
|
*/
|
|
37
37
|
"failureThresholdExpirationInSeconds"?: number;
|
|
38
38
|
/**
|
|
39
|
-
* The maximum number of IP addresses permitted with the same device fingerprint. If unspecified, defaults to
|
|
39
|
+
* The maximum number of IP addresses permitted with the same device fingerprint. If unspecified, defaults to {@code 20}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
40
40
|
*/
|
|
41
41
|
"maxAddressCount"?: number;
|
|
42
42
|
/**
|
|
43
|
-
* The number of seconds before the maximum addresses count resets. If unspecified, defaults to
|
|
43
|
+
* The number of seconds before the maximum addresses count resets. If unspecified, defaults to {@code 60}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
44
44
|
*/
|
|
45
45
|
"maxAddressCountExpirationInSeconds"?: number;
|
|
46
46
|
"challengeSettings"?: model.BlockChallengeSettings;
|
|
@@ -22,14 +22,14 @@ export interface ExtendHttpResponseHeaderAction extends model.HeaderManipulation
|
|
|
22
22
|
/**
|
|
23
23
|
* A header field name that conforms to RFC 7230.
|
|
24
24
|
* <p>
|
|
25
|
-
Example:
|
|
25
|
+
Example: {@code example_header_name}
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
28
28
|
"header": string;
|
|
29
29
|
/**
|
|
30
30
|
* A header field value that conforms to RFC 7230.
|
|
31
31
|
* <p>
|
|
32
|
-
Example:
|
|
32
|
+
Example: {@code example_value}
|
|
33
33
|
*
|
|
34
34
|
*/
|
|
35
35
|
"value": string;
|
|
@@ -28,7 +28,7 @@ export interface HealthCheck {
|
|
|
28
28
|
*/
|
|
29
29
|
"path"?: string;
|
|
30
30
|
/**
|
|
31
|
-
* HTTP header fields to include in health check requests, expressed as
|
|
31
|
+
* HTTP header fields to include in health check requests, expressed as {@code \"name\": \"value\"} properties. Because HTTP header field names are case-insensitive, any use of names that are case-insensitive equal to other names will be rejected. If Host is not specified, requests will include a Host header field with value matching the policy's protected domain. If User-Agent is not specified, requests will include a User-Agent header field with value \"waf health checks\".
|
|
32
32
|
* <p>
|
|
33
33
|
**Note:** The only currently-supported header fields are Host and User-Agent.
|
|
34
34
|
*/
|
|
@@ -53,7 +53,7 @@ export interface HttpRedirectSummary {
|
|
|
53
53
|
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
|
|
54
54
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
55
55
|
* <p>
|
|
56
|
-
Example:
|
|
56
|
+
Example: {@code {\"Department\": \"Finance\"}}
|
|
57
57
|
*
|
|
58
58
|
*/
|
|
59
59
|
"freeformTags"?: {
|
|
@@ -63,7 +63,7 @@ export interface HttpRedirectSummary {
|
|
|
63
63
|
* Defined tags for this resource. Each key is predefined and scoped to a namespace.
|
|
64
64
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
65
65
|
* <p>
|
|
66
|
-
Example:
|
|
66
|
+
Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
|
|
67
67
|
*
|
|
68
68
|
*/
|
|
69
69
|
"definedTags"?: {
|
|
@@ -53,7 +53,7 @@ export interface HttpRedirect {
|
|
|
53
53
|
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
|
|
54
54
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
55
55
|
* <p>
|
|
56
|
-
Example:
|
|
56
|
+
Example: {@code {\"Department\": \"Finance\"}}
|
|
57
57
|
*
|
|
58
58
|
*/
|
|
59
59
|
"freeformTags"?: {
|
|
@@ -63,7 +63,7 @@ export interface HttpRedirect {
|
|
|
63
63
|
* Defined tags for this resource. Each key is predefined and scoped to a namespace.
|
|
64
64
|
* For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
|
|
65
65
|
* <p>
|
|
66
|
-
Example:
|
|
66
|
+
Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
|
|
67
67
|
*
|
|
68
68
|
*/
|
|
69
69
|
"definedTags"?: {
|
|
@@ -20,31 +20,31 @@ export interface HumanInteractionChallenge {
|
|
|
20
20
|
*/
|
|
21
21
|
"isEnabled": boolean;
|
|
22
22
|
/**
|
|
23
|
-
* The action to take against requests from detected bots. If unspecified, defaults to
|
|
23
|
+
* The action to take against requests from detected bots. If unspecified, defaults to {@code DETECT}.
|
|
24
24
|
*/
|
|
25
25
|
"action"?: HumanInteractionChallenge.Action;
|
|
26
26
|
/**
|
|
27
|
-
* The number of failed requests before taking action. If unspecified, defaults to
|
|
27
|
+
* The number of failed requests before taking action. If unspecified, defaults to {@code 10}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
28
28
|
*/
|
|
29
29
|
"failureThreshold"?: number;
|
|
30
30
|
/**
|
|
31
|
-
* The number of seconds between challenges for the same IP address. If unspecified, defaults to
|
|
31
|
+
* The number of seconds between challenges for the same IP address. If unspecified, defaults to {@code 60}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
32
32
|
*/
|
|
33
33
|
"actionExpirationInSeconds"?: number;
|
|
34
34
|
/**
|
|
35
|
-
* The number of seconds before the failure threshold resets. If unspecified, defaults to
|
|
35
|
+
* The number of seconds before the failure threshold resets. If unspecified, defaults to {@code 60}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
36
36
|
*/
|
|
37
37
|
"failureThresholdExpirationInSeconds"?: number;
|
|
38
38
|
/**
|
|
39
|
-
* The number of interactions required to pass the challenge. If unspecified, defaults to
|
|
39
|
+
* The number of interactions required to pass the challenge. If unspecified, defaults to {@code 3}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
40
40
|
*/
|
|
41
41
|
"interactionThreshold"?: number;
|
|
42
42
|
/**
|
|
43
|
-
* The number of seconds to record the interactions from the user. If unspecified, defaults to
|
|
43
|
+
* The number of seconds to record the interactions from the user. If unspecified, defaults to {@code 15}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
44
44
|
*/
|
|
45
45
|
"recordingPeriodInSeconds"?: number;
|
|
46
46
|
/**
|
|
47
|
-
* Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the
|
|
47
|
+
* Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the {@code action} is set to {@code DETECT}.
|
|
48
48
|
*/
|
|
49
49
|
"setHttpHeader"?: model.Header;
|
|
50
50
|
"challengeSettings"?: model.BlockChallengeSettings;
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
*/
|
|
13
13
|
import * as model from "../model";
|
|
14
14
|
/**
|
|
15
|
-
* An object that represents the
|
|
15
|
+
* An object that represents the {@code ip-hash} load balancing method.
|
|
16
16
|
*
|
|
17
17
|
*/
|
|
18
18
|
export interface IPHashLoadBalancingMethod extends model.LoadBalancingMethod {
|
|
@@ -20,19 +20,19 @@ export interface JsChallenge {
|
|
|
20
20
|
*/
|
|
21
21
|
"isEnabled": boolean;
|
|
22
22
|
/**
|
|
23
|
-
* The action to take against requests from detected bots. If unspecified, defaults to
|
|
23
|
+
* The action to take against requests from detected bots. If unspecified, defaults to {@code DETECT}.
|
|
24
24
|
*/
|
|
25
25
|
"action"?: JsChallenge.Action;
|
|
26
26
|
/**
|
|
27
|
-
* The number of failed requests before taking action. If unspecified, defaults to
|
|
27
|
+
* The number of failed requests before taking action. If unspecified, defaults to {@code 10}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
28
28
|
*/
|
|
29
29
|
"failureThreshold"?: number;
|
|
30
30
|
/**
|
|
31
|
-
* The number of seconds between challenges from the same IP address. If unspecified, defaults to
|
|
31
|
+
* The number of seconds between challenges from the same IP address. If unspecified, defaults to {@code 60}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
32
32
|
*/
|
|
33
33
|
"actionExpirationInSeconds"?: number;
|
|
34
34
|
/**
|
|
35
|
-
* Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the
|
|
35
|
+
* Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the {@code action} is set to {@code DETECT}.
|
|
36
36
|
*/
|
|
37
37
|
"setHttpHeader"?: model.Header;
|
|
38
38
|
"challengeSettings"?: model.BlockChallengeSettings;
|
package/lib/model/origin.d.ts
CHANGED
|
@@ -16,15 +16,15 @@ import * as model from "../model";
|
|
|
16
16
|
*/
|
|
17
17
|
export interface Origin {
|
|
18
18
|
/**
|
|
19
|
-
* The URI of the origin. Does not support paths. Port numbers should be specified in the
|
|
19
|
+
* The URI of the origin. Does not support paths. Port numbers should be specified in the {@code httpPort} and {@code httpsPort} fields.
|
|
20
20
|
*/
|
|
21
21
|
"uri": string;
|
|
22
22
|
/**
|
|
23
|
-
* The HTTP port on the origin that the web application listens on. If unspecified, defaults to
|
|
23
|
+
* The HTTP port on the origin that the web application listens on. If unspecified, defaults to {@code 80}. If {@code 0} is specified - the origin is not used for HTTP traffic. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
24
24
|
*/
|
|
25
25
|
"httpPort"?: number;
|
|
26
26
|
/**
|
|
27
|
-
* The HTTPS port on the origin that the web application listens on. If unspecified, defaults to
|
|
27
|
+
* The HTTPS port on the origin that the web application listens on. If unspecified, defaults to {@code 443}. If {@code 0} is specified - the origin is not used for HTTPS traffic. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
28
28
|
*/
|
|
29
29
|
"httpsPort"?: number;
|
|
30
30
|
/**
|
|
@@ -20,11 +20,11 @@ export interface PolicyConfig {
|
|
|
20
20
|
*/
|
|
21
21
|
"certificateId"?: string;
|
|
22
22
|
/**
|
|
23
|
-
* Enable or disable HTTPS support. If true, a
|
|
23
|
+
* Enable or disable HTTPS support. If true, a {@code certificateId} is required. If unspecified, defaults to {@code false}.
|
|
24
24
|
*/
|
|
25
25
|
"isHttpsEnabled"?: boolean;
|
|
26
26
|
/**
|
|
27
|
-
* Force HTTP to HTTPS redirection. If unspecified, defaults to
|
|
27
|
+
* Force HTTP to HTTPS redirection. If unspecified, defaults to {@code false}.
|
|
28
28
|
*/
|
|
29
29
|
"isHttpsForced"?: boolean;
|
|
30
30
|
/**
|
|
@@ -38,39 +38,39 @@ export interface PolicyConfig {
|
|
|
38
38
|
* <p>
|
|
39
39
|
- **TLS_V1_3:** corresponds to TLS 1.3 specification.
|
|
40
40
|
* <p>
|
|
41
|
-
Enabled TLS protocols must go in a row. For example if
|
|
41
|
+
Enabled TLS protocols must go in a row. For example if {@code TLS_v1_1} and {@code TLS_V1_3} are enabled, {@code TLS_V1_2} must be enabled too.
|
|
42
42
|
*/
|
|
43
43
|
"tlsProtocols"?: Array<PolicyConfig.TlsProtocols>;
|
|
44
44
|
/**
|
|
45
|
-
* Enable or disable GZIP compression of origin responses. If enabled, the header
|
|
45
|
+
* Enable or disable GZIP compression of origin responses. If enabled, the header {@code Accept-Encoding: gzip} is sent to origin, otherwise, the empty {@code Accept-Encoding:} header is used.
|
|
46
46
|
*/
|
|
47
47
|
"isOriginCompressionEnabled"?: boolean;
|
|
48
48
|
/**
|
|
49
|
-
* Enabling
|
|
49
|
+
* Enabling {@code isBehindCdn} allows for the collection of IP addresses from client requests if the WAF is connected to a CDN.
|
|
50
50
|
*/
|
|
51
51
|
"isBehindCdn"?: boolean;
|
|
52
52
|
/**
|
|
53
|
-
* Specifies an HTTP header name which is treated as the connecting client's IP address. Applicable only if
|
|
53
|
+
* Specifies an HTTP header name which is treated as the connecting client's IP address. Applicable only if {@code isBehindCdn} is enabled.
|
|
54
54
|
* <p>
|
|
55
55
|
The edge node reads this header and its value and sets the client IP address as specified. It does not create the header if the header is not present in the request. If the header is not present, the connecting IP address will be used as the client's true IP address. It uses the last IP address in the header's value as the true IP address.
|
|
56
56
|
* <p>
|
|
57
|
-
Example:
|
|
57
|
+
Example: {@code X-Client-Ip: 11.1.1.1, 13.3.3.3}
|
|
58
58
|
* <p>
|
|
59
59
|
In the case of multiple headers with the same name, only the first header will be used. It is assumed that CDN sets the correct client IP address to prevent spoofing.
|
|
60
60
|
* <p>
|
|
61
|
-
- **X_FORWARDED_FOR:** Corresponds to
|
|
61
|
+
- **X_FORWARDED_FOR:** Corresponds to {@code X-Forwarded-For} header name.
|
|
62
62
|
* <p>
|
|
63
|
-
- **X_CLIENT_IP:** Corresponds to
|
|
63
|
+
- **X_CLIENT_IP:** Corresponds to {@code X-Client-Ip} header name.
|
|
64
64
|
* <p>
|
|
65
|
-
- **X_REAL_IP:** Corresponds to
|
|
65
|
+
- **X_REAL_IP:** Corresponds to {@code X-Real-Ip} header name.
|
|
66
66
|
* <p>
|
|
67
|
-
- **CLIENT_IP:** Corresponds to
|
|
67
|
+
- **CLIENT_IP:** Corresponds to {@code Client-Ip} header name.
|
|
68
68
|
* <p>
|
|
69
|
-
- **TRUE_CLIENT_IP:** Corresponds to
|
|
69
|
+
- **TRUE_CLIENT_IP:** Corresponds to {@code True-Client-Ip} header name.
|
|
70
70
|
*/
|
|
71
71
|
"clientAddressHeader"?: PolicyConfig.ClientAddressHeader;
|
|
72
72
|
/**
|
|
73
|
-
* Enable or disable automatic content caching based on the response
|
|
73
|
+
* Enable or disable automatic content caching based on the response {@code cache-control} header. This feature enables the origin to act as a proxy cache. Caching is usually defined using {@code cache-control} header. For example {@code cache-control: max-age=120} means that the returned resource is valid for 120 seconds. Caching rules will overwrite this setting.
|
|
74
74
|
*/
|
|
75
75
|
"isCacheControlRespected"?: boolean;
|
|
76
76
|
/**
|
|
@@ -79,7 +79,7 @@ export interface PolicyConfig {
|
|
|
79
79
|
"isResponseBufferingEnabled"?: boolean;
|
|
80
80
|
/**
|
|
81
81
|
* The set cipher group for the configured TLS protocol. This sets the configuration for the TLS connections between clients and edge nodes only.
|
|
82
|
-
* - **DEFAULT:** Cipher group supports TLS 1.0, TLS 1.1, TLS 1.2, TLS 1.3 protocols. It has the following ciphers enabled:
|
|
82
|
+
* - **DEFAULT:** Cipher group supports TLS 1.0, TLS 1.1, TLS 1.2, TLS 1.3 protocols. It has the following ciphers enabled: {@code ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:kEDH+AESGCM:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA:DHE-RSA-AES256-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:AES:CAMELLIA:!DES-CBC3-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA}
|
|
83
83
|
*/
|
|
84
84
|
"cipherGroup"?: PolicyConfig.CipherGroup;
|
|
85
85
|
/**
|
|
@@ -87,7 +87,7 @@ export interface PolicyConfig {
|
|
|
87
87
|
*/
|
|
88
88
|
"loadBalancingMethod"?: model.RoundRobinLoadBalancingMethod | model.StickyCookieLoadBalancingMethod | model.IPHashLoadBalancingMethod;
|
|
89
89
|
/**
|
|
90
|
-
* ModSecurity is not capable to inspect WebSockets. Therefore paths specified here have WAF disabled if Connection request header from the client has the value Upgrade (case insensitive matching) and Upgrade request header has the value websocket (case insensitive matching). Paths matches if the concatenation of request URL path and query starts with the contents of the one of
|
|
90
|
+
* ModSecurity is not capable to inspect WebSockets. Therefore paths specified here have WAF disabled if Connection request header from the client has the value Upgrade (case insensitive matching) and Upgrade request header has the value websocket (case insensitive matching). Paths matches if the concatenation of request URL path and query starts with the contents of the one of {@code websocketPathPrefixes} array value. In All other cases challenges, like JSC, HIC and etc., remain active.
|
|
91
91
|
*/
|
|
92
92
|
"websocketPathPrefixes"?: Array<string>;
|
|
93
93
|
/**
|
|
@@ -20,11 +20,11 @@ export interface ProtectionRuleAction {
|
|
|
20
20
|
*/
|
|
21
21
|
"key": string;
|
|
22
22
|
/**
|
|
23
|
-
* The action to apply to the protection rule. If unspecified, defaults to
|
|
23
|
+
* The action to apply to the protection rule. If unspecified, defaults to {@code OFF}.
|
|
24
24
|
*/
|
|
25
25
|
"action": ProtectionRuleAction.Action;
|
|
26
26
|
/**
|
|
27
|
-
* The types of requests excluded from the protection rule action. If the requests matches the criteria in the
|
|
27
|
+
* The types of requests excluded from the protection rule action. If the requests matches the criteria in the {@code exclusions}, the protection rule action will not be executed.
|
|
28
28
|
*/
|
|
29
29
|
"exclusions"?: Array<model.ProtectionRuleExclusion>;
|
|
30
30
|
}
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
|
|
12
12
|
*/
|
|
13
13
|
/**
|
|
14
|
-
* Allows specified types of requests to bypass the protection rule. If a request matches any of the criteria in the
|
|
14
|
+
* Allows specified types of requests to bypass the protection rule. If a request matches any of the criteria in the {@code 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:
|
|
15
15
|
* <p>
|
|
16
16
|
\"action\": \"BLOCK\",
|
|
17
17
|
* \"exclusions\": [
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
* ],
|
|
27
27
|
* \"key\": \"1000000\",
|
|
28
28
|
* <p>
|
|
29
|
-
A request with the cookie name
|
|
29
|
+
A request with the cookie name {@code sessionid} would trigger an exclusion. A request with the cookie name {@code yourcompany.com} would *not* trigger and exclusion.
|
|
30
30
|
*/
|
|
31
31
|
export interface ProtectionRuleExclusion {
|
|
32
32
|
/**
|
|
@@ -32,13 +32,13 @@ export interface ProtectionRule {
|
|
|
32
32
|
*/
|
|
33
33
|
"description"?: string;
|
|
34
34
|
/**
|
|
35
|
-
* The action to take when the traffic is detected as malicious. If unspecified, defaults to
|
|
35
|
+
* The action to take when the traffic is detected as malicious. If unspecified, defaults to {@code OFF}.
|
|
36
36
|
*/
|
|
37
37
|
"action"?: ProtectionRule.Action;
|
|
38
38
|
/**
|
|
39
39
|
* The list of labels for the protection rule.
|
|
40
40
|
* <p>
|
|
41
|
-
**Note:** Protection rules with a
|
|
41
|
+
**Note:** Protection rules with a {@code ResponseBody} label will have no effect unless {@code isResponseInspected} is true.
|
|
42
42
|
*/
|
|
43
43
|
"labels"?: Array<string>;
|
|
44
44
|
"exclusions"?: Array<model.ProtectionRuleExclusion>;
|
|
@@ -15,63 +15,63 @@
|
|
|
15
15
|
*/
|
|
16
16
|
export interface ProtectionSettings {
|
|
17
17
|
/**
|
|
18
|
-
* If
|
|
18
|
+
* If {@code action} is set to {@code BLOCK}, this specifies how the traffic is blocked when detected as malicious by a protection rule. If unspecified, defaults to {@code SET_RESPONSE_CODE}.
|
|
19
19
|
*/
|
|
20
20
|
"blockAction"?: ProtectionSettings.BlockAction;
|
|
21
21
|
/**
|
|
22
|
-
* The response code returned when
|
|
22
|
+
* The response code returned when {@code action} is set to {@code BLOCK}, {@code blockAction} is set to {@code SET_RESPONSE_CODE}, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to {@code 403}. The list of available response codes: {@code 400}, {@code 401}, {@code 403}, {@code 405}, {@code 409}, {@code 411}, {@code 412}, {@code 413}, {@code 414}, {@code 415}, {@code 416}, {@code 500}, {@code 501}, {@code 502}, {@code 503}, {@code 504}, {@code 507}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
23
23
|
*/
|
|
24
24
|
"blockResponseCode"?: number;
|
|
25
25
|
/**
|
|
26
|
-
* The message to show on the error page when
|
|
26
|
+
* The message to show on the error page when {@code action} is set to {@code BLOCK}, {@code blockAction} is set to {@code SHOW_ERROR_PAGE}, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to 'Access to the website is blocked.'
|
|
27
27
|
*/
|
|
28
28
|
"blockErrorPageMessage"?: string;
|
|
29
29
|
/**
|
|
30
|
-
* The error code to show on the error page when
|
|
30
|
+
* The error code to show on the error page when {@code action} is set to {@code BLOCK}, {@code blockAction} is set to {@code SHOW_ERROR_PAGE}, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to {@code 403}.
|
|
31
31
|
*/
|
|
32
32
|
"blockErrorPageCode"?: string;
|
|
33
33
|
/**
|
|
34
|
-
* The description text to show on the error page when
|
|
34
|
+
* The description text to show on the error page when {@code action} is set to {@code BLOCK}, {@code blockAction} is set to {@code SHOW_ERROR_PAGE}, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to {@code Access blocked by website owner. Please contact support.}
|
|
35
35
|
*/
|
|
36
36
|
"blockErrorPageDescription"?: string;
|
|
37
37
|
/**
|
|
38
|
-
* The maximum number of arguments allowed to be passed to your application before an action is taken. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to
|
|
38
|
+
* The maximum number of arguments allowed to be passed to your application before an action is taken. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to {@code 255}. This setting only applies if a corresponding protection rule is enabled, such as the \"Number of Arguments Limits\" rule (key: 960335).
|
|
39
39
|
* <p>
|
|
40
|
-
Example: If
|
|
41
|
-
*
|
|
42
|
-
*
|
|
40
|
+
Example: If {@code maxArgumentCount} to {@code 2} for the Max Number of Arguments protection rule (key: 960335), the following requests would be blocked:
|
|
41
|
+
* {@code GET /myapp/path?query=one&query=two&query=three}
|
|
42
|
+
* {@code POST /myapp/path} with Body {@code {\"argument1\":\"one\",\"argument2\":\"two\",\"argument3\":\"three\"}} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
43
43
|
*/
|
|
44
44
|
"maxArgumentCount"?: number;
|
|
45
45
|
/**
|
|
46
|
-
* The maximum length allowed for each argument name, in characters. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to
|
|
46
|
+
* The maximum length allowed for each argument name, in characters. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to {@code 400}. This setting only applies if a corresponding protection rule is enabled, such as the \"Values Limits\" rule (key: 960208). Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
47
47
|
*/
|
|
48
48
|
"maxNameLengthPerArgument"?: number;
|
|
49
49
|
/**
|
|
50
|
-
* The maximum length allowed for the sum of the argument name and value, in characters. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to
|
|
50
|
+
* The maximum length allowed for the sum of the argument name and value, in characters. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to {@code 64000}. This setting only applies if a corresponding protection rule is enabled, such as the \"Total Arguments Limits\" rule (key: 960341). Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
51
51
|
*/
|
|
52
52
|
"maxTotalNameLengthOfArguments"?: number;
|
|
53
53
|
/**
|
|
54
|
-
* The length of time to analyze traffic traffic, in days. After the analysis period,
|
|
54
|
+
* The length of time to analyze traffic traffic, in days. After the analysis period, {@code WafRecommendations} will be populated. If unspecified, defaults to {@code 10}.
|
|
55
55
|
* <p>
|
|
56
|
-
Use
|
|
56
|
+
Use {@code GET /waasPolicies/{waasPolicyId}/wafRecommendations} to view WAF recommendations. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
57
57
|
*/
|
|
58
58
|
"recommendationsPeriodInDays"?: number;
|
|
59
59
|
/**
|
|
60
|
-
* Inspects the response body of origin responses. Can be used to detect leakage of sensitive data. If unspecified, defaults to
|
|
60
|
+
* Inspects the response body of origin responses. Can be used to detect leakage of sensitive data. If unspecified, defaults to {@code false}.
|
|
61
61
|
* <p>
|
|
62
|
-
**Note:** Only origin responses with a Content-Type matching a value in
|
|
62
|
+
**Note:** Only origin responses with a Content-Type matching a value in {@code mediaTypes} will be inspected.
|
|
63
63
|
*/
|
|
64
64
|
"isResponseInspected"?: boolean;
|
|
65
65
|
/**
|
|
66
|
-
* The maximum response size to be fully inspected, in binary kilobytes (KiB). Anything over this limit will be partially inspected. If unspecified, defaults to
|
|
66
|
+
* The maximum response size to be fully inspected, in binary kilobytes (KiB). Anything over this limit will be partially inspected. If unspecified, defaults to {@code 1024}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
|
|
67
67
|
*/
|
|
68
68
|
"maxResponseSizeInKiB"?: number;
|
|
69
69
|
/**
|
|
70
|
-
* The list of allowed HTTP methods. If unspecified, default to
|
|
70
|
+
* The list of allowed HTTP methods. If unspecified, default to {@code [OPTIONS, GET, HEAD, POST]}. This setting only applies if a corresponding protection rule is enabled, such as the \"Restrict HTTP Request Methods\" rule (key: 911100).
|
|
71
71
|
*/
|
|
72
72
|
"allowedHttpMethods"?: Array<ProtectionSettings.AllowedHttpMethods>;
|
|
73
73
|
/**
|
|
74
|
-
* The list of media types to allow for inspection, if
|
|
74
|
+
* The list of media types to allow for inspection, if {@code isResponseInspected} is enabled. Only responses with MIME types in this list will be inspected. If unspecified, defaults to {@code [\"text/html\", \"text/plain\", \"text/xml\"]}.
|
|
75
75
|
* <p>
|
|
76
76
|
Supported MIME types include:
|
|
77
77
|
* <p>
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
*/
|
|
16
16
|
export interface PurgeCache {
|
|
17
17
|
/**
|
|
18
|
-
* A resource to purge, specified by either a hostless absolute path starting with a single slash (Example:
|
|
18
|
+
* A resource to purge, specified by either a hostless absolute path starting with a single slash (Example: {@code /path/to/resource}) or by a relative path in which the first component will be interpreted as a domain protected by the WAAS policy (Example: {@code example.com/path/to/resource}).
|
|
19
19
|
*/
|
|
20
20
|
"resources"?: Array<string>;
|
|
21
21
|
}
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
/**
|
|
14
14
|
* 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.
|
|
15
15
|
* <p>
|
|
16
|
-
Use the
|
|
16
|
+
Use the {@code POST /waasPolicies/{waasPolicyId}/actions/acceptWafConfigRecommendations} method to accept recommended protection rules.
|
|
17
17
|
*/
|
|
18
18
|
export interface Recommendation {
|
|
19
19
|
/**
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
*/
|
|
13
13
|
import * as model from "../model";
|
|
14
14
|
/**
|
|
15
|
-
* An object that represents the
|
|
15
|
+
* An object that represents the {@code round-robin} load balancing method.
|
|
16
16
|
*
|
|
17
17
|
*/
|
|
18
18
|
export interface RoundRobinLoadBalancingMethod extends model.LoadBalancingMethod {
|