oci-waas 2.5.1 → 2.7.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/LICENSE.txt +6 -0
- package/lib/client.d.ts +150 -72
- package/lib/client.js +308 -144
- package/lib/client.js.map +1 -1
- package/lib/request/accept-recommendations-request.d.ts +1 -1
- package/lib/request/cancel-work-request-request.d.ts +1 -1
- package/lib/request/change-address-list-compartment-request.d.ts +1 -1
- package/lib/request/change-certificate-compartment-request.d.ts +1 -1
- package/lib/request/change-custom-protection-rule-compartment-request.d.ts +1 -1
- package/lib/request/change-http-redirect-compartment-request.d.ts +1 -1
- package/lib/request/change-waas-policy-compartment-request.d.ts +1 -1
- 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 +1 -1
- package/lib/request/delete-certificate-request.d.ts +1 -1
- package/lib/request/delete-custom-protection-rule-request.d.ts +1 -1
- package/lib/request/delete-http-redirect-request.d.ts +1 -1
- package/lib/request/delete-waas-policy-request.d.ts +1 -1
- 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 +1 -1
- package/lib/request/list-address-lists-request.d.ts +1 -1
- package/lib/request/list-caching-rules-request.d.ts +1 -1
- package/lib/request/list-captchas-request.d.ts +1 -1
- package/lib/request/list-certificates-request.d.ts +1 -1
- package/lib/request/list-custom-protection-rules-request.d.ts +1 -1
- package/lib/request/list-edge-subnets-request.d.ts +1 -1
- package/lib/request/list-good-bots-request.d.ts +1 -1
- package/lib/request/list-http-redirects-request.d.ts +1 -1
- package/lib/request/list-protection-rules-request.d.ts +1 -1
- package/lib/request/list-recommendations-request.d.ts +1 -1
- package/lib/request/list-threat-feeds-request.d.ts +1 -1
- package/lib/request/list-waas-policies-request.d.ts +1 -1
- package/lib/request/list-waas-policy-custom-protection-rules-request.d.ts +1 -1
- package/lib/request/list-waf-blocked-requests-request.d.ts +1 -1
- package/lib/request/list-waf-logs-request.d.ts +1 -1
- package/lib/request/list-waf-requests-request.d.ts +1 -1
- package/lib/request/list-waf-traffic-request.d.ts +1 -1
- package/lib/request/list-whitelists-request.d.ts +1 -1
- package/lib/request/list-work-requests-request.d.ts +1 -1
- package/lib/request/purge-cache-request.d.ts +1 -1
- package/lib/request/update-access-rules-request.d.ts +1 -1
- package/lib/request/update-address-list-request.d.ts +1 -1
- package/lib/request/update-caching-rules-request.d.ts +1 -1
- package/lib/request/update-captchas-request.d.ts +1 -1
- package/lib/request/update-certificate-request.d.ts +1 -1
- package/lib/request/update-custom-protection-rule-request.d.ts +1 -1
- package/lib/request/update-device-fingerprint-challenge-request.d.ts +1 -1
- package/lib/request/update-good-bots-request.d.ts +1 -1
- package/lib/request/update-http-redirect-request.d.ts +1 -1
- package/lib/request/update-human-interaction-challenge-request.d.ts +1 -1
- package/lib/request/update-js-challenge-request.d.ts +1 -1
- package/lib/request/update-policy-config-request.d.ts +1 -1
- package/lib/request/update-protection-rules-request.d.ts +1 -1
- package/lib/request/update-protection-settings-request.d.ts +1 -1
- package/lib/request/update-threat-feeds-request.d.ts +1 -1
- package/lib/request/update-waas-policy-custom-protection-rules-request.d.ts +1 -1
- package/lib/request/update-waas-policy-request.d.ts +1 -1
- package/lib/request/update-waf-address-rate-limiting-request.d.ts +1 -1
- package/lib/request/update-waf-config-request.d.ts +1 -1
- package/lib/request/update-whitelists-request.d.ts +1 -1
- package/package.json +3 -3
package/lib/client.d.ts
CHANGED
|
@@ -19,6 +19,9 @@ import { WaasWaiter } from "./waas-waiter";
|
|
|
19
19
|
export declare enum RedirectApiKeys {
|
|
20
20
|
ApiKey = 0
|
|
21
21
|
}
|
|
22
|
+
/**
|
|
23
|
+
* This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.
|
|
24
|
+
*/
|
|
22
25
|
export declare class RedirectClient {
|
|
23
26
|
protected static serviceEndpointTemplate: string;
|
|
24
27
|
protected "_endpoint": string;
|
|
@@ -68,42 +71,47 @@ export declare class RedirectClient {
|
|
|
68
71
|
getWaiters(): RedirectWaiter;
|
|
69
72
|
/**
|
|
70
73
|
* Moves HTTP Redirect into a different compartment. When provided, If-Match is checked against ETag values of the WAAS policy.
|
|
74
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
71
75
|
* @param ChangeHttpRedirectCompartmentRequest
|
|
72
76
|
* @return ChangeHttpRedirectCompartmentResponse
|
|
73
77
|
* @throws OciError when an error occurs
|
|
74
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
78
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ChangeHttpRedirectCompartment.ts.html |here} to see how to use ChangeHttpRedirectCompartment API.
|
|
75
79
|
*/
|
|
76
80
|
changeHttpRedirectCompartment(changeHttpRedirectCompartmentRequest: requests.ChangeHttpRedirectCompartmentRequest): Promise<responses.ChangeHttpRedirectCompartmentResponse>;
|
|
77
81
|
/**
|
|
78
82
|
* Creates a new HTTP Redirect on the WAF edge.
|
|
83
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
79
84
|
* @param CreateHttpRedirectRequest
|
|
80
85
|
* @return CreateHttpRedirectResponse
|
|
81
86
|
* @throws OciError when an error occurs
|
|
82
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
87
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/CreateHttpRedirect.ts.html |here} to see how to use CreateHttpRedirect API.
|
|
83
88
|
*/
|
|
84
89
|
createHttpRedirect(createHttpRedirectRequest: requests.CreateHttpRedirectRequest): Promise<responses.CreateHttpRedirectResponse>;
|
|
85
90
|
/**
|
|
86
91
|
* Deletes a redirect.
|
|
92
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
87
93
|
* @param DeleteHttpRedirectRequest
|
|
88
94
|
* @return DeleteHttpRedirectResponse
|
|
89
95
|
* @throws OciError when an error occurs
|
|
90
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
96
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/DeleteHttpRedirect.ts.html |here} to see how to use DeleteHttpRedirect API.
|
|
91
97
|
*/
|
|
92
98
|
deleteHttpRedirect(deleteHttpRedirectRequest: requests.DeleteHttpRedirectRequest): Promise<responses.DeleteHttpRedirectResponse>;
|
|
93
99
|
/**
|
|
94
100
|
* Gets the details of a HTTP Redirect.
|
|
101
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
95
102
|
* @param GetHttpRedirectRequest
|
|
96
103
|
* @return GetHttpRedirectResponse
|
|
97
104
|
* @throws OciError when an error occurs
|
|
98
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
105
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/GetHttpRedirect.ts.html |here} to see how to use GetHttpRedirect API.
|
|
99
106
|
*/
|
|
100
107
|
getHttpRedirect(getHttpRedirectRequest: requests.GetHttpRedirectRequest): Promise<responses.GetHttpRedirectResponse>;
|
|
101
108
|
/**
|
|
102
109
|
* Gets a list of HTTP Redirects.
|
|
110
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
103
111
|
* @param ListHttpRedirectsRequest
|
|
104
112
|
* @return ListHttpRedirectsResponse
|
|
105
113
|
* @throws OciError when an error occurs
|
|
106
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
114
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListHttpRedirects.ts.html |here} to see how to use ListHttpRedirects API.
|
|
107
115
|
*/
|
|
108
116
|
listHttpRedirects(listHttpRedirectsRequest: requests.ListHttpRedirectsRequest): Promise<responses.ListHttpRedirectsResponse>;
|
|
109
117
|
/**
|
|
@@ -140,16 +148,20 @@ export declare class RedirectClient {
|
|
|
140
148
|
listHttpRedirectsResponseIterator(request: requests.ListHttpRedirectsRequest): AsyncIterableIterator<responses.ListHttpRedirectsResponse>;
|
|
141
149
|
/**
|
|
142
150
|
* Updates the details of a HTTP Redirect, including target and tags. Only the fields specified in the request body will be updated; all other properties will remain unchanged.
|
|
151
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
143
152
|
* @param UpdateHttpRedirectRequest
|
|
144
153
|
* @return UpdateHttpRedirectResponse
|
|
145
154
|
* @throws OciError when an error occurs
|
|
146
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
155
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateHttpRedirect.ts.html |here} to see how to use UpdateHttpRedirect API.
|
|
147
156
|
*/
|
|
148
157
|
updateHttpRedirect(updateHttpRedirectRequest: requests.UpdateHttpRedirectRequest): Promise<responses.UpdateHttpRedirectResponse>;
|
|
149
158
|
}
|
|
150
159
|
export declare enum WaasApiKeys {
|
|
151
160
|
ApiKey = 0
|
|
152
161
|
}
|
|
162
|
+
/**
|
|
163
|
+
* This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.
|
|
164
|
+
*/
|
|
153
165
|
export declare class WaasClient {
|
|
154
166
|
protected static serviceEndpointTemplate: string;
|
|
155
167
|
protected "_endpoint": string;
|
|
@@ -201,18 +213,20 @@ export declare class WaasClient {
|
|
|
201
213
|
* 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.
|
|
202
214
|
* <p>
|
|
203
215
|
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).
|
|
216
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
204
217
|
* @param AcceptRecommendationsRequest
|
|
205
218
|
* @return AcceptRecommendationsResponse
|
|
206
219
|
* @throws OciError when an error occurs
|
|
207
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
220
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/AcceptRecommendations.ts.html |here} to see how to use AcceptRecommendations API.
|
|
208
221
|
*/
|
|
209
222
|
acceptRecommendations(acceptRecommendationsRequest: requests.AcceptRecommendationsRequest): Promise<responses.AcceptRecommendationsResponse>;
|
|
210
223
|
/**
|
|
211
224
|
* Cancels a specified work request.
|
|
225
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
212
226
|
* @param CancelWorkRequestRequest
|
|
213
227
|
* @return CancelWorkRequestResponse
|
|
214
228
|
* @throws OciError when an error occurs
|
|
215
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
229
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequest API.
|
|
216
230
|
*/
|
|
217
231
|
cancelWorkRequest(cancelWorkRequestRequest: requests.CancelWorkRequestRequest): Promise<responses.CancelWorkRequestResponse>;
|
|
218
232
|
/**
|
|
@@ -220,66 +234,73 @@ export declare class WaasClient {
|
|
|
220
234
|
* is checked against ETag values of the address list. For information about moving
|
|
221
235
|
* resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
|
|
222
236
|
*
|
|
237
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
223
238
|
* @param ChangeAddressListCompartmentRequest
|
|
224
239
|
* @return ChangeAddressListCompartmentResponse
|
|
225
240
|
* @throws OciError when an error occurs
|
|
226
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
241
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ChangeAddressListCompartment.ts.html |here} to see how to use ChangeAddressListCompartment API.
|
|
227
242
|
*/
|
|
228
243
|
changeAddressListCompartment(changeAddressListCompartmentRequest: requests.ChangeAddressListCompartmentRequest): Promise<responses.ChangeAddressListCompartmentResponse>;
|
|
229
244
|
/**
|
|
230
245
|
* Moves certificate into a different compartment. When provided, If-Match is checked against ETag values of the certificate.
|
|
231
246
|
* For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
|
|
232
247
|
*
|
|
248
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
233
249
|
* @param ChangeCertificateCompartmentRequest
|
|
234
250
|
* @return ChangeCertificateCompartmentResponse
|
|
235
251
|
* @throws OciError when an error occurs
|
|
236
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
252
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ChangeCertificateCompartment.ts.html |here} to see how to use ChangeCertificateCompartment API.
|
|
237
253
|
*/
|
|
238
254
|
changeCertificateCompartment(changeCertificateCompartmentRequest: requests.ChangeCertificateCompartmentRequest): Promise<responses.ChangeCertificateCompartmentResponse>;
|
|
239
255
|
/**
|
|
240
256
|
* Moves a custom protection rule into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the custom protection rule. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
|
|
257
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
241
258
|
* @param ChangeCustomProtectionRuleCompartmentRequest
|
|
242
259
|
* @return ChangeCustomProtectionRuleCompartmentResponse
|
|
243
260
|
* @throws OciError when an error occurs
|
|
244
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
261
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ChangeCustomProtectionRuleCompartment.ts.html |here} to see how to use ChangeCustomProtectionRuleCompartment API.
|
|
245
262
|
*/
|
|
246
263
|
changeCustomProtectionRuleCompartment(changeCustomProtectionRuleCompartmentRequest: requests.ChangeCustomProtectionRuleCompartmentRequest): Promise<responses.ChangeCustomProtectionRuleCompartmentResponse>;
|
|
247
264
|
/**
|
|
248
265
|
* Moves WAAS policy into a different compartment. When provided, If-Match is checked against ETag values of the WAAS policy.
|
|
249
266
|
* For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
|
|
250
267
|
*
|
|
268
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
251
269
|
* @param ChangeWaasPolicyCompartmentRequest
|
|
252
270
|
* @return ChangeWaasPolicyCompartmentResponse
|
|
253
271
|
* @throws OciError when an error occurs
|
|
254
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
272
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ChangeWaasPolicyCompartment.ts.html |here} to see how to use ChangeWaasPolicyCompartment API.
|
|
255
273
|
*/
|
|
256
274
|
changeWaasPolicyCompartment(changeWaasPolicyCompartmentRequest: requests.ChangeWaasPolicyCompartmentRequest): Promise<responses.ChangeWaasPolicyCompartmentResponse>;
|
|
257
275
|
/**
|
|
258
276
|
* 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.
|
|
277
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
259
278
|
* @param CreateAddressListRequest
|
|
260
279
|
* @return CreateAddressListResponse
|
|
261
280
|
* @throws OciError when an error occurs
|
|
262
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
281
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/CreateAddressList.ts.html |here} to see how to use CreateAddressList API.
|
|
263
282
|
*/
|
|
264
283
|
createAddressList(createAddressListRequest: requests.CreateAddressListRequest): Promise<responses.CreateAddressListResponse>;
|
|
265
284
|
/**
|
|
266
285
|
* 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.
|
|
267
286
|
* <p>
|
|
268
287
|
For more information, see [WAF Settings](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/wafsettings.htm).
|
|
288
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
269
289
|
* @param CreateCertificateRequest
|
|
270
290
|
* @return CreateCertificateResponse
|
|
271
291
|
* @throws OciError when an error occurs
|
|
272
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
292
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/CreateCertificate.ts.html |here} to see how to use CreateCertificate API.
|
|
273
293
|
*/
|
|
274
294
|
createCertificate(createCertificateRequest: requests.CreateCertificateRequest): Promise<responses.CreateCertificateResponse>;
|
|
275
295
|
/**
|
|
276
296
|
* Creates a new custom protection rule in the specified compartment.
|
|
277
297
|
* <p>
|
|
278
298
|
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).
|
|
299
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
279
300
|
* @param CreateCustomProtectionRuleRequest
|
|
280
301
|
* @return CreateCustomProtectionRuleResponse
|
|
281
302
|
* @throws OciError when an error occurs
|
|
282
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
303
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/CreateCustomProtectionRule.ts.html |here} to see how to use CreateCustomProtectionRule API.
|
|
283
304
|
*/
|
|
284
305
|
createCustomProtectionRule(createCustomProtectionRuleRequest: requests.CreateCustomProtectionRuleRequest): Promise<responses.CreateCustomProtectionRuleResponse>;
|
|
285
306
|
/**
|
|
@@ -296,155 +317,174 @@ export declare class WaasClient {
|
|
|
296
317
|
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).
|
|
297
318
|
* <p>
|
|
298
319
|
**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.
|
|
320
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
299
321
|
* @param CreateWaasPolicyRequest
|
|
300
322
|
* @return CreateWaasPolicyResponse
|
|
301
323
|
* @throws OciError when an error occurs
|
|
302
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
324
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/CreateWaasPolicy.ts.html |here} to see how to use CreateWaasPolicy API.
|
|
303
325
|
*/
|
|
304
326
|
createWaasPolicy(createWaasPolicyRequest: requests.CreateWaasPolicyRequest): Promise<responses.CreateWaasPolicyResponse>;
|
|
305
327
|
/**
|
|
306
328
|
* Deletes the address list from the compartment if it is not used.
|
|
329
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
307
330
|
* @param DeleteAddressListRequest
|
|
308
331
|
* @return DeleteAddressListResponse
|
|
309
332
|
* @throws OciError when an error occurs
|
|
310
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
333
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/DeleteAddressList.ts.html |here} to see how to use DeleteAddressList API.
|
|
311
334
|
*/
|
|
312
335
|
deleteAddressList(deleteAddressListRequest: requests.DeleteAddressListRequest): Promise<responses.DeleteAddressListResponse>;
|
|
313
336
|
/**
|
|
314
337
|
* Deletes an SSL certificate from the WAAS service.
|
|
338
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
315
339
|
* @param DeleteCertificateRequest
|
|
316
340
|
* @return DeleteCertificateResponse
|
|
317
341
|
* @throws OciError when an error occurs
|
|
318
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
342
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/DeleteCertificate.ts.html |here} to see how to use DeleteCertificate API.
|
|
319
343
|
*/
|
|
320
344
|
deleteCertificate(deleteCertificateRequest: requests.DeleteCertificateRequest): Promise<responses.DeleteCertificateResponse>;
|
|
321
345
|
/**
|
|
322
346
|
* Deletes a Custom Protection rule.
|
|
347
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
323
348
|
* @param DeleteCustomProtectionRuleRequest
|
|
324
349
|
* @return DeleteCustomProtectionRuleResponse
|
|
325
350
|
* @throws OciError when an error occurs
|
|
326
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
351
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/DeleteCustomProtectionRule.ts.html |here} to see how to use DeleteCustomProtectionRule API.
|
|
327
352
|
*/
|
|
328
353
|
deleteCustomProtectionRule(deleteCustomProtectionRuleRequest: requests.DeleteCustomProtectionRuleRequest): Promise<responses.DeleteCustomProtectionRuleResponse>;
|
|
329
354
|
/**
|
|
330
355
|
* Deletes a policy.
|
|
356
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
331
357
|
* @param DeleteWaasPolicyRequest
|
|
332
358
|
* @return DeleteWaasPolicyResponse
|
|
333
359
|
* @throws OciError when an error occurs
|
|
334
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
360
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/DeleteWaasPolicy.ts.html |here} to see how to use DeleteWaasPolicy API.
|
|
335
361
|
*/
|
|
336
362
|
deleteWaasPolicy(deleteWaasPolicyRequest: requests.DeleteWaasPolicyRequest): Promise<responses.DeleteWaasPolicyResponse>;
|
|
337
363
|
/**
|
|
338
364
|
* Gets the details of an address list.
|
|
365
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
339
366
|
* @param GetAddressListRequest
|
|
340
367
|
* @return GetAddressListResponse
|
|
341
368
|
* @throws OciError when an error occurs
|
|
342
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
369
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/GetAddressList.ts.html |here} to see how to use GetAddressList API.
|
|
343
370
|
*/
|
|
344
371
|
getAddressList(getAddressListRequest: requests.GetAddressListRequest): Promise<responses.GetAddressListResponse>;
|
|
345
372
|
/**
|
|
346
373
|
* Gets the details of an SSL certificate.
|
|
374
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
347
375
|
* @param GetCertificateRequest
|
|
348
376
|
* @return GetCertificateResponse
|
|
349
377
|
* @throws OciError when an error occurs
|
|
350
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
378
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/GetCertificate.ts.html |here} to see how to use GetCertificate API.
|
|
351
379
|
*/
|
|
352
380
|
getCertificate(getCertificateRequest: requests.GetCertificateRequest): Promise<responses.GetCertificateResponse>;
|
|
353
381
|
/**
|
|
354
382
|
* Gets the details of a custom protection rule.
|
|
383
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
355
384
|
* @param GetCustomProtectionRuleRequest
|
|
356
385
|
* @return GetCustomProtectionRuleResponse
|
|
357
386
|
* @throws OciError when an error occurs
|
|
358
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
387
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/GetCustomProtectionRule.ts.html |here} to see how to use GetCustomProtectionRule API.
|
|
359
388
|
*/
|
|
360
389
|
getCustomProtectionRule(getCustomProtectionRuleRequest: requests.GetCustomProtectionRuleRequest): Promise<responses.GetCustomProtectionRuleResponse>;
|
|
361
390
|
/**
|
|
362
391
|
* Gets the device fingerprint challenge settings in the Web Application Firewall configuration for a WAAS policy.
|
|
392
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
363
393
|
* @param GetDeviceFingerprintChallengeRequest
|
|
364
394
|
* @return GetDeviceFingerprintChallengeResponse
|
|
365
395
|
* @throws OciError when an error occurs
|
|
366
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
396
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/GetDeviceFingerprintChallenge.ts.html |here} to see how to use GetDeviceFingerprintChallenge API.
|
|
367
397
|
*/
|
|
368
398
|
getDeviceFingerprintChallenge(getDeviceFingerprintChallengeRequest: requests.GetDeviceFingerprintChallengeRequest): Promise<responses.GetDeviceFingerprintChallengeResponse>;
|
|
369
399
|
/**
|
|
370
400
|
* Gets the human interaction challenge settings in the Web Application Firewall configuration for a WAAS policy.
|
|
401
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
371
402
|
* @param GetHumanInteractionChallengeRequest
|
|
372
403
|
* @return GetHumanInteractionChallengeResponse
|
|
373
404
|
* @throws OciError when an error occurs
|
|
374
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
405
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/GetHumanInteractionChallenge.ts.html |here} to see how to use GetHumanInteractionChallenge API.
|
|
375
406
|
*/
|
|
376
407
|
getHumanInteractionChallenge(getHumanInteractionChallengeRequest: requests.GetHumanInteractionChallengeRequest): Promise<responses.GetHumanInteractionChallengeResponse>;
|
|
377
408
|
/**
|
|
378
409
|
* Gets the JavaScript challenge settings in the Web Application Firewall configuration for a WAAS policy.
|
|
410
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
379
411
|
* @param GetJsChallengeRequest
|
|
380
412
|
* @return GetJsChallengeResponse
|
|
381
413
|
* @throws OciError when an error occurs
|
|
382
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
414
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/GetJsChallenge.ts.html |here} to see how to use GetJsChallenge API.
|
|
383
415
|
*/
|
|
384
416
|
getJsChallenge(getJsChallengeRequest: requests.GetJsChallengeRequest): Promise<responses.GetJsChallengeResponse>;
|
|
385
417
|
/**
|
|
386
418
|
* Gets the configuration of a WAAS policy.
|
|
419
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
387
420
|
* @param GetPolicyConfigRequest
|
|
388
421
|
* @return GetPolicyConfigResponse
|
|
389
422
|
* @throws OciError when an error occurs
|
|
390
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
423
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/GetPolicyConfig.ts.html |here} to see how to use GetPolicyConfig API.
|
|
391
424
|
*/
|
|
392
425
|
getPolicyConfig(getPolicyConfigRequest: requests.GetPolicyConfigRequest): Promise<responses.GetPolicyConfigResponse>;
|
|
393
426
|
/**
|
|
394
427
|
* Gets the details of a protection rule in the Web Application Firewall configuration for a WAAS policy.
|
|
428
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
395
429
|
* @param GetProtectionRuleRequest
|
|
396
430
|
* @return GetProtectionRuleResponse
|
|
397
431
|
* @throws OciError when an error occurs
|
|
398
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
432
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/GetProtectionRule.ts.html |here} to see how to use GetProtectionRule API.
|
|
399
433
|
*/
|
|
400
434
|
getProtectionRule(getProtectionRuleRequest: requests.GetProtectionRuleRequest): Promise<responses.GetProtectionRuleResponse>;
|
|
401
435
|
/**
|
|
402
436
|
* Gets the protection settings in the Web Application Firewall configuration for a WAAS policy.
|
|
437
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
403
438
|
* @param GetProtectionSettingsRequest
|
|
404
439
|
* @return GetProtectionSettingsResponse
|
|
405
440
|
* @throws OciError when an error occurs
|
|
406
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
441
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/GetProtectionSettings.ts.html |here} to see how to use GetProtectionSettings API.
|
|
407
442
|
*/
|
|
408
443
|
getProtectionSettings(getProtectionSettingsRequest: requests.GetProtectionSettingsRequest): Promise<responses.GetProtectionSettingsResponse>;
|
|
409
444
|
/**
|
|
410
445
|
* Gets the details of a WAAS policy.
|
|
446
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
411
447
|
* @param GetWaasPolicyRequest
|
|
412
448
|
* @return GetWaasPolicyResponse
|
|
413
449
|
* @throws OciError when an error occurs
|
|
414
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
450
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/GetWaasPolicy.ts.html |here} to see how to use GetWaasPolicy API.
|
|
415
451
|
*/
|
|
416
452
|
getWaasPolicy(getWaasPolicyRequest: requests.GetWaasPolicyRequest): Promise<responses.GetWaasPolicyResponse>;
|
|
417
453
|
/**
|
|
418
454
|
* Gets the address rate limiting settings of the Web Application Firewall configuration for a WAAS policy.
|
|
455
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
419
456
|
* @param GetWafAddressRateLimitingRequest
|
|
420
457
|
* @return GetWafAddressRateLimitingResponse
|
|
421
458
|
* @throws OciError when an error occurs
|
|
422
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
459
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/GetWafAddressRateLimiting.ts.html |here} to see how to use GetWafAddressRateLimiting API.
|
|
423
460
|
*/
|
|
424
461
|
getWafAddressRateLimiting(getWafAddressRateLimitingRequest: requests.GetWafAddressRateLimitingRequest): Promise<responses.GetWafAddressRateLimitingResponse>;
|
|
425
462
|
/**
|
|
426
463
|
* Gets the Web Application Firewall configuration details for a WAAS policy.
|
|
464
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
427
465
|
* @param GetWafConfigRequest
|
|
428
466
|
* @return GetWafConfigResponse
|
|
429
467
|
* @throws OciError when an error occurs
|
|
430
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
468
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/GetWafConfig.ts.html |here} to see how to use GetWafConfig API.
|
|
431
469
|
*/
|
|
432
470
|
getWafConfig(getWafConfigRequest: requests.GetWafConfigRequest): Promise<responses.GetWafConfigResponse>;
|
|
433
471
|
/**
|
|
434
472
|
* Gets the details of a specified work request.
|
|
473
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
435
474
|
* @param GetWorkRequestRequest
|
|
436
475
|
* @return GetWorkRequestResponse
|
|
437
476
|
* @throws OciError when an error occurs
|
|
438
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
477
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
|
|
439
478
|
*/
|
|
440
479
|
getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
|
|
441
480
|
/**
|
|
442
481
|
* Gets the currently configured access rules for the Web Application Firewall configuration of a specified WAAS policy.
|
|
443
482
|
* 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.
|
|
483
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
444
484
|
* @param ListAccessRulesRequest
|
|
445
485
|
* @return ListAccessRulesResponse
|
|
446
486
|
* @throws OciError when an error occurs
|
|
447
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
487
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListAccessRules.ts.html |here} to see how to use ListAccessRules API.
|
|
448
488
|
*/
|
|
449
489
|
listAccessRules(listAccessRulesRequest: requests.ListAccessRulesRequest): Promise<responses.ListAccessRulesResponse>;
|
|
450
490
|
/**
|
|
@@ -481,10 +521,11 @@ export declare class WaasClient {
|
|
|
481
521
|
listAccessRulesResponseIterator(request: requests.ListAccessRulesRequest): AsyncIterableIterator<responses.ListAccessRulesResponse>;
|
|
482
522
|
/**
|
|
483
523
|
* Gets a list of address lists that can be used in a WAAS policy.
|
|
524
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
484
525
|
* @param ListAddressListsRequest
|
|
485
526
|
* @return ListAddressListsResponse
|
|
486
527
|
* @throws OciError when an error occurs
|
|
487
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
528
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListAddressLists.ts.html |here} to see how to use ListAddressLists API.
|
|
488
529
|
*/
|
|
489
530
|
listAddressLists(listAddressListsRequest: requests.ListAddressListsRequest): Promise<responses.ListAddressListsResponse>;
|
|
490
531
|
/**
|
|
@@ -522,10 +563,11 @@ export declare class WaasClient {
|
|
|
522
563
|
/**
|
|
523
564
|
* Gets the currently configured caching rules for the Web Application Firewall configuration of a specified WAAS policy.
|
|
524
565
|
* The rules are processed in the order they are specified in and the first matching rule will be used when processing a request.
|
|
566
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
525
567
|
* @param ListCachingRulesRequest
|
|
526
568
|
* @return ListCachingRulesResponse
|
|
527
569
|
* @throws OciError when an error occurs
|
|
528
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
570
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListCachingRules.ts.html |here} to see how to use ListCachingRules API.
|
|
529
571
|
*/
|
|
530
572
|
listCachingRules(listCachingRulesRequest: requests.ListCachingRulesRequest): Promise<responses.ListCachingRulesResponse>;
|
|
531
573
|
/**
|
|
@@ -567,10 +609,11 @@ export declare class WaasClient {
|
|
|
567
609
|
The order of the CAPTCHA challenges is important. The URL for each
|
|
568
610
|
* CAPTCHA will be checked in the order they are created.
|
|
569
611
|
*
|
|
612
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
570
613
|
* @param ListCaptchasRequest
|
|
571
614
|
* @return ListCaptchasResponse
|
|
572
615
|
* @throws OciError when an error occurs
|
|
573
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
616
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListCaptchas.ts.html |here} to see how to use ListCaptchas API.
|
|
574
617
|
*/
|
|
575
618
|
listCaptchas(listCaptchasRequest: requests.ListCaptchasRequest): Promise<responses.ListCaptchasResponse>;
|
|
576
619
|
/**
|
|
@@ -607,10 +650,11 @@ export declare class WaasClient {
|
|
|
607
650
|
listCaptchasResponseIterator(request: requests.ListCaptchasRequest): AsyncIterableIterator<responses.ListCaptchasResponse>;
|
|
608
651
|
/**
|
|
609
652
|
* Gets a list of SSL certificates that can be used in a WAAS policy.
|
|
653
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
610
654
|
* @param ListCertificatesRequest
|
|
611
655
|
* @return ListCertificatesResponse
|
|
612
656
|
* @throws OciError when an error occurs
|
|
613
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
657
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListCertificates.ts.html |here} to see how to use ListCertificates API.
|
|
614
658
|
*/
|
|
615
659
|
listCertificates(listCertificatesRequest: requests.ListCertificatesRequest): Promise<responses.ListCertificatesResponse>;
|
|
616
660
|
/**
|
|
@@ -647,10 +691,11 @@ export declare class WaasClient {
|
|
|
647
691
|
listCertificatesResponseIterator(request: requests.ListCertificatesRequest): AsyncIterableIterator<responses.ListCertificatesResponse>;
|
|
648
692
|
/**
|
|
649
693
|
* Gets a list of custom protection rules for the specified Web Application Firewall.
|
|
694
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
650
695
|
* @param ListCustomProtectionRulesRequest
|
|
651
696
|
* @return ListCustomProtectionRulesResponse
|
|
652
697
|
* @throws OciError when an error occurs
|
|
653
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
698
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListCustomProtectionRules.ts.html |here} to see how to use ListCustomProtectionRules API.
|
|
654
699
|
*/
|
|
655
700
|
listCustomProtectionRules(listCustomProtectionRulesRequest: requests.ListCustomProtectionRulesRequest): Promise<responses.ListCustomProtectionRulesResponse>;
|
|
656
701
|
/**
|
|
@@ -687,10 +732,11 @@ export declare class WaasClient {
|
|
|
687
732
|
listCustomProtectionRulesResponseIterator(request: requests.ListCustomProtectionRulesRequest): AsyncIterableIterator<responses.ListCustomProtectionRulesResponse>;
|
|
688
733
|
/**
|
|
689
734
|
* 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.
|
|
735
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
690
736
|
* @param ListEdgeSubnetsRequest
|
|
691
737
|
* @return ListEdgeSubnetsResponse
|
|
692
738
|
* @throws OciError when an error occurs
|
|
693
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
739
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListEdgeSubnets.ts.html |here} to see how to use ListEdgeSubnets API.
|
|
694
740
|
*/
|
|
695
741
|
listEdgeSubnets(listEdgeSubnetsRequest: requests.ListEdgeSubnetsRequest): Promise<responses.ListEdgeSubnetsResponse>;
|
|
696
742
|
/**
|
|
@@ -730,10 +776,11 @@ export declare class WaasClient {
|
|
|
730
776
|
* <p>
|
|
731
777
|
The list is sorted by `key`, in ascending order.
|
|
732
778
|
*
|
|
779
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
733
780
|
* @param ListGoodBotsRequest
|
|
734
781
|
* @return ListGoodBotsResponse
|
|
735
782
|
* @throws OciError when an error occurs
|
|
736
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
783
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListGoodBots.ts.html |here} to see how to use ListGoodBots API.
|
|
737
784
|
*/
|
|
738
785
|
listGoodBots(listGoodBotsRequest: requests.ListGoodBotsRequest): Promise<responses.ListGoodBotsResponse>;
|
|
739
786
|
/**
|
|
@@ -771,10 +818,11 @@ export declare class WaasClient {
|
|
|
771
818
|
/**
|
|
772
819
|
* 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.
|
|
773
820
|
* The list is sorted by `key`, in ascending order.
|
|
821
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
774
822
|
* @param ListProtectionRulesRequest
|
|
775
823
|
* @return ListProtectionRulesResponse
|
|
776
824
|
* @throws OciError when an error occurs
|
|
777
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
825
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListProtectionRules.ts.html |here} to see how to use ListProtectionRules API.
|
|
778
826
|
*/
|
|
779
827
|
listProtectionRules(listProtectionRulesRequest: requests.ListProtectionRulesRequest): Promise<responses.ListProtectionRulesResponse>;
|
|
780
828
|
/**
|
|
@@ -814,10 +862,11 @@ export declare class WaasClient {
|
|
|
814
862
|
* <p>
|
|
815
863
|
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).
|
|
816
864
|
* The list is sorted by `key`, in ascending order.
|
|
865
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
817
866
|
* @param ListRecommendationsRequest
|
|
818
867
|
* @return ListRecommendationsResponse
|
|
819
868
|
* @throws OciError when an error occurs
|
|
820
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
869
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListRecommendations.ts.html |here} to see how to use ListRecommendations API.
|
|
821
870
|
*/
|
|
822
871
|
listRecommendations(listRecommendationsRequest: requests.ListRecommendationsRequest): Promise<responses.ListRecommendationsResponse>;
|
|
823
872
|
/**
|
|
@@ -857,10 +906,11 @@ export declare class WaasClient {
|
|
|
857
906
|
* and the actions set for each feed. The list is sorted by `key`,
|
|
858
907
|
* in ascending order.
|
|
859
908
|
*
|
|
909
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
860
910
|
* @param ListThreatFeedsRequest
|
|
861
911
|
* @return ListThreatFeedsResponse
|
|
862
912
|
* @throws OciError when an error occurs
|
|
863
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
913
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListThreatFeeds.ts.html |here} to see how to use ListThreatFeeds API.
|
|
864
914
|
*/
|
|
865
915
|
listThreatFeeds(listThreatFeedsRequest: requests.ListThreatFeedsRequest): Promise<responses.ListThreatFeedsResponse>;
|
|
866
916
|
/**
|
|
@@ -897,10 +947,11 @@ export declare class WaasClient {
|
|
|
897
947
|
listThreatFeedsResponseIterator(request: requests.ListThreatFeedsRequest): AsyncIterableIterator<responses.ListThreatFeedsResponse>;
|
|
898
948
|
/**
|
|
899
949
|
* Gets a list of WAAS policies.
|
|
950
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
900
951
|
* @param ListWaasPoliciesRequest
|
|
901
952
|
* @return ListWaasPoliciesResponse
|
|
902
953
|
* @throws OciError when an error occurs
|
|
903
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
954
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListWaasPolicies.ts.html |here} to see how to use ListWaasPolicies API.
|
|
904
955
|
*/
|
|
905
956
|
listWaasPolicies(listWaasPoliciesRequest: requests.ListWaasPoliciesRequest): Promise<responses.ListWaasPoliciesResponse>;
|
|
906
957
|
/**
|
|
@@ -937,10 +988,11 @@ export declare class WaasClient {
|
|
|
937
988
|
listWaasPoliciesResponseIterator(request: requests.ListWaasPoliciesRequest): AsyncIterableIterator<responses.ListWaasPoliciesResponse>;
|
|
938
989
|
/**
|
|
939
990
|
* Gets the list of currently configured custom protection rules for a WAAS policy.
|
|
991
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
940
992
|
* @param ListWaasPolicyCustomProtectionRulesRequest
|
|
941
993
|
* @return ListWaasPolicyCustomProtectionRulesResponse
|
|
942
994
|
* @throws OciError when an error occurs
|
|
943
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
995
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListWaasPolicyCustomProtectionRules.ts.html |here} to see how to use ListWaasPolicyCustomProtectionRules API.
|
|
944
996
|
*/
|
|
945
997
|
listWaasPolicyCustomProtectionRules(listWaasPolicyCustomProtectionRulesRequest: requests.ListWaasPolicyCustomProtectionRulesRequest): Promise<responses.ListWaasPolicyCustomProtectionRulesResponse>;
|
|
946
998
|
/**
|
|
@@ -977,10 +1029,11 @@ export declare class WaasClient {
|
|
|
977
1029
|
listWaasPolicyCustomProtectionRulesResponseIterator(request: requests.ListWaasPolicyCustomProtectionRulesRequest): AsyncIterableIterator<responses.ListWaasPolicyCustomProtectionRulesResponse>;
|
|
978
1030
|
/**
|
|
979
1031
|
* 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).
|
|
1032
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
980
1033
|
* @param ListWafBlockedRequestsRequest
|
|
981
1034
|
* @return ListWafBlockedRequestsResponse
|
|
982
1035
|
* @throws OciError when an error occurs
|
|
983
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1036
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListWafBlockedRequests.ts.html |here} to see how to use ListWafBlockedRequests API.
|
|
984
1037
|
*/
|
|
985
1038
|
listWafBlockedRequests(listWafBlockedRequestsRequest: requests.ListWafBlockedRequestsRequest): Promise<responses.ListWafBlockedRequestsResponse>;
|
|
986
1039
|
/**
|
|
@@ -1020,10 +1073,11 @@ export declare class WaasClient {
|
|
|
1020
1073
|
* policy. Sorted by the `timeObserved` in ascending order (starting from the
|
|
1021
1074
|
* oldest recorded event).
|
|
1022
1075
|
*
|
|
1076
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1023
1077
|
* @param ListWafLogsRequest
|
|
1024
1078
|
* @return ListWafLogsResponse
|
|
1025
1079
|
* @throws OciError when an error occurs
|
|
1026
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1080
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListWafLogs.ts.html |here} to see how to use ListWafLogs API.
|
|
1027
1081
|
*/
|
|
1028
1082
|
listWafLogs(listWafLogsRequest: requests.ListWafLogsRequest): Promise<responses.ListWafLogsResponse>;
|
|
1029
1083
|
/**
|
|
@@ -1063,10 +1117,11 @@ export declare class WaasClient {
|
|
|
1063
1117
|
* over a specified period of time, including blocked requests. Sorted
|
|
1064
1118
|
* by `timeObserved` in ascending order (starting from oldest requests).
|
|
1065
1119
|
*
|
|
1120
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1066
1121
|
* @param ListWafRequestsRequest
|
|
1067
1122
|
* @return ListWafRequestsResponse
|
|
1068
1123
|
* @throws OciError when an error occurs
|
|
1069
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1124
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListWafRequests.ts.html |here} to see how to use ListWafRequests API.
|
|
1070
1125
|
*/
|
|
1071
1126
|
listWafRequests(listWafRequestsRequest: requests.ListWafRequestsRequest): Promise<responses.ListWafRequestsResponse>;
|
|
1072
1127
|
/**
|
|
@@ -1105,10 +1160,11 @@ export declare class WaasClient {
|
|
|
1105
1160
|
* Gets the Web Application Firewall traffic data for a WAAS policy.
|
|
1106
1161
|
* Sorted by `timeObserved` in ascending order (starting from oldest data).
|
|
1107
1162
|
*
|
|
1163
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1108
1164
|
* @param ListWafTrafficRequest
|
|
1109
1165
|
* @return ListWafTrafficResponse
|
|
1110
1166
|
* @throws OciError when an error occurs
|
|
1111
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1167
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListWafTraffic.ts.html |here} to see how to use ListWafTraffic API.
|
|
1112
1168
|
*/
|
|
1113
1169
|
listWafTraffic(listWafTrafficRequest: requests.ListWafTrafficRequest): Promise<responses.ListWafTrafficResponse>;
|
|
1114
1170
|
/**
|
|
@@ -1145,10 +1201,11 @@ export declare class WaasClient {
|
|
|
1145
1201
|
listWafTrafficResponseIterator(request: requests.ListWafTrafficRequest): AsyncIterableIterator<responses.ListWafTrafficResponse>;
|
|
1146
1202
|
/**
|
|
1147
1203
|
* Gets the list of whitelists defined in the Web Application Firewall configuration for a WAAS policy.
|
|
1204
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1148
1205
|
* @param ListWhitelistsRequest
|
|
1149
1206
|
* @return ListWhitelistsResponse
|
|
1150
1207
|
* @throws OciError when an error occurs
|
|
1151
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1208
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListWhitelists.ts.html |here} to see how to use ListWhitelists API.
|
|
1152
1209
|
*/
|
|
1153
1210
|
listWhitelists(listWhitelistsRequest: requests.ListWhitelistsRequest): Promise<responses.ListWhitelistsResponse>;
|
|
1154
1211
|
/**
|
|
@@ -1185,10 +1242,11 @@ export declare class WaasClient {
|
|
|
1185
1242
|
listWhitelistsResponseIterator(request: requests.ListWhitelistsRequest): AsyncIterableIterator<responses.ListWhitelistsResponse>;
|
|
1186
1243
|
/**
|
|
1187
1244
|
* 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.
|
|
1245
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1188
1246
|
* @param ListWorkRequestsRequest
|
|
1189
1247
|
* @return ListWorkRequestsResponse
|
|
1190
1248
|
* @throws OciError when an error occurs
|
|
1191
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1249
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
|
|
1192
1250
|
*/
|
|
1193
1251
|
listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
|
|
1194
1252
|
/**
|
|
@@ -1226,10 +1284,11 @@ export declare class WaasClient {
|
|
|
1226
1284
|
/**
|
|
1227
1285
|
* 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.
|
|
1228
1286
|
* For more information, see [Caching Rules](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/cachingrules.htm#purge).
|
|
1287
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1229
1288
|
* @param PurgeCacheRequest
|
|
1230
1289
|
* @return PurgeCacheResponse
|
|
1231
1290
|
* @throws OciError when an error occurs
|
|
1232
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1291
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/PurgeCache.ts.html |here} to see how to use PurgeCache API.
|
|
1233
1292
|
*/
|
|
1234
1293
|
purgeCache(purgeCacheRequest: requests.PurgeCacheRequest): Promise<responses.PurgeCacheResponse>;
|
|
1235
1294
|
/**
|
|
@@ -1242,18 +1301,20 @@ export declare class WaasClient {
|
|
|
1242
1301
|
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.
|
|
1243
1302
|
* <p>
|
|
1244
1303
|
Any existing access rules that are not specified with a `key` in the list of access rules will be deleted upon update.
|
|
1304
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1245
1305
|
* @param UpdateAccessRulesRequest
|
|
1246
1306
|
* @return UpdateAccessRulesResponse
|
|
1247
1307
|
* @throws OciError when an error occurs
|
|
1248
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1308
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateAccessRules.ts.html |here} to see how to use UpdateAccessRules API.
|
|
1249
1309
|
*/
|
|
1250
1310
|
updateAccessRules(updateAccessRulesRequest: requests.UpdateAccessRulesRequest): Promise<responses.UpdateAccessRulesResponse>;
|
|
1251
1311
|
/**
|
|
1252
1312
|
* Updates the details of an address list. Only the fields specified in the request body will be updated; all other properties will remain unchanged.
|
|
1313
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1253
1314
|
* @param UpdateAddressListRequest
|
|
1254
1315
|
* @return UpdateAddressListResponse
|
|
1255
1316
|
* @throws OciError when an error occurs
|
|
1256
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1317
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateAddressList.ts.html |here} to see how to use UpdateAddressList API.
|
|
1257
1318
|
*/
|
|
1258
1319
|
updateAddressList(updateAddressListRequest: requests.UpdateAddressListRequest): Promise<responses.UpdateAddressListResponse>;
|
|
1259
1320
|
/**
|
|
@@ -1264,10 +1325,11 @@ export declare class WaasClient {
|
|
|
1264
1325
|
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.
|
|
1265
1326
|
* <p>
|
|
1266
1327
|
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.
|
|
1328
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1267
1329
|
* @param UpdateCachingRulesRequest
|
|
1268
1330
|
* @return UpdateCachingRulesResponse
|
|
1269
1331
|
* @throws OciError when an error occurs
|
|
1270
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1332
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateCachingRules.ts.html |here} to see how to use UpdateCachingRules API.
|
|
1271
1333
|
*/
|
|
1272
1334
|
updateCachingRules(updateCachingRulesRequest: requests.UpdateCachingRulesRequest): Promise<responses.UpdateCachingRulesResponse>;
|
|
1273
1335
|
/**
|
|
@@ -1280,26 +1342,29 @@ export declare class WaasClient {
|
|
|
1280
1342
|
Any existing CAPTCHA challenges that are not specified with a `key` in the list of CAPTCHA challenges will be deleted upon update.
|
|
1281
1343
|
* <p>
|
|
1282
1344
|
Query parameters are allowed in CAPTCHA URL.
|
|
1345
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1283
1346
|
* @param UpdateCaptchasRequest
|
|
1284
1347
|
* @return UpdateCaptchasResponse
|
|
1285
1348
|
* @throws OciError when an error occurs
|
|
1286
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1349
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateCaptchas.ts.html |here} to see how to use UpdateCaptchas API.
|
|
1287
1350
|
*/
|
|
1288
1351
|
updateCaptchas(updateCaptchasRequest: requests.UpdateCaptchasRequest): Promise<responses.UpdateCaptchasResponse>;
|
|
1289
1352
|
/**
|
|
1290
1353
|
* 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.
|
|
1354
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1291
1355
|
* @param UpdateCertificateRequest
|
|
1292
1356
|
* @return UpdateCertificateResponse
|
|
1293
1357
|
* @throws OciError when an error occurs
|
|
1294
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1358
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateCertificate.ts.html |here} to see how to use UpdateCertificate API.
|
|
1295
1359
|
*/
|
|
1296
1360
|
updateCertificate(updateCertificateRequest: requests.UpdateCertificateRequest): Promise<responses.UpdateCertificateResponse>;
|
|
1297
1361
|
/**
|
|
1298
1362
|
* 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.
|
|
1363
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1299
1364
|
* @param UpdateCustomProtectionRuleRequest
|
|
1300
1365
|
* @return UpdateCustomProtectionRuleResponse
|
|
1301
1366
|
* @throws OciError when an error occurs
|
|
1302
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1367
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateCustomProtectionRule.ts.html |here} to see how to use UpdateCustomProtectionRule API.
|
|
1303
1368
|
*/
|
|
1304
1369
|
updateCustomProtectionRule(updateCustomProtectionRuleRequest: requests.UpdateCustomProtectionRuleRequest): Promise<responses.UpdateCustomProtectionRuleResponse>;
|
|
1305
1370
|
/**
|
|
@@ -1308,96 +1373,107 @@ export declare class WaasClient {
|
|
|
1308
1373
|
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.
|
|
1309
1374
|
* <p>
|
|
1310
1375
|
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.
|
|
1376
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1311
1377
|
* @param UpdateDeviceFingerprintChallengeRequest
|
|
1312
1378
|
* @return UpdateDeviceFingerprintChallengeResponse
|
|
1313
1379
|
* @throws OciError when an error occurs
|
|
1314
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1380
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateDeviceFingerprintChallenge.ts.html |here} to see how to use UpdateDeviceFingerprintChallenge API.
|
|
1315
1381
|
*/
|
|
1316
1382
|
updateDeviceFingerprintChallenge(updateDeviceFingerprintChallengeRequest: requests.UpdateDeviceFingerprintChallengeRequest): Promise<responses.UpdateDeviceFingerprintChallengeResponse>;
|
|
1317
1383
|
/**
|
|
1318
1384
|
* 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.
|
|
1319
1385
|
* <p>
|
|
1320
1386
|
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).
|
|
1387
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1321
1388
|
* @param UpdateGoodBotsRequest
|
|
1322
1389
|
* @return UpdateGoodBotsResponse
|
|
1323
1390
|
* @throws OciError when an error occurs
|
|
1324
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1391
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateGoodBots.ts.html |here} to see how to use UpdateGoodBots API.
|
|
1325
1392
|
*/
|
|
1326
1393
|
updateGoodBots(updateGoodBotsRequest: requests.UpdateGoodBotsRequest): Promise<responses.UpdateGoodBotsResponse>;
|
|
1327
1394
|
/**
|
|
1328
1395
|
* 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.
|
|
1396
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1329
1397
|
* @param UpdateHumanInteractionChallengeRequest
|
|
1330
1398
|
* @return UpdateHumanInteractionChallengeResponse
|
|
1331
1399
|
* @throws OciError when an error occurs
|
|
1332
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1400
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateHumanInteractionChallenge.ts.html |here} to see how to use UpdateHumanInteractionChallenge API.
|
|
1333
1401
|
*/
|
|
1334
1402
|
updateHumanInteractionChallenge(updateHumanInteractionChallengeRequest: requests.UpdateHumanInteractionChallengeRequest): Promise<responses.UpdateHumanInteractionChallengeResponse>;
|
|
1335
1403
|
/**
|
|
1336
1404
|
* 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](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/botmanagement.htm).
|
|
1405
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1337
1406
|
* @param UpdateJsChallengeRequest
|
|
1338
1407
|
* @return UpdateJsChallengeResponse
|
|
1339
1408
|
* @throws OciError when an error occurs
|
|
1340
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1409
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateJsChallenge.ts.html |here} to see how to use UpdateJsChallenge API.
|
|
1341
1410
|
*/
|
|
1342
1411
|
updateJsChallenge(updateJsChallengeRequest: requests.UpdateJsChallengeRequest): Promise<responses.UpdateJsChallengeResponse>;
|
|
1343
1412
|
/**
|
|
1344
1413
|
* Updates the configuration for a WAAS policy. Only the fields specified in the request body will be updated; all other properties will remain unchanged.
|
|
1414
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1345
1415
|
* @param UpdatePolicyConfigRequest
|
|
1346
1416
|
* @return UpdatePolicyConfigResponse
|
|
1347
1417
|
* @throws OciError when an error occurs
|
|
1348
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1418
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdatePolicyConfig.ts.html |here} to see how to use UpdatePolicyConfig API.
|
|
1349
1419
|
*/
|
|
1350
1420
|
updatePolicyConfig(updatePolicyConfigRequest: requests.UpdatePolicyConfigRequest): Promise<responses.UpdatePolicyConfigResponse>;
|
|
1351
1421
|
/**
|
|
1352
1422
|
* 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](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/wafprotectionrules.htm).
|
|
1353
1423
|
* This operation can update or disable protection rules depending on the structure of the request body.
|
|
1354
1424
|
* Protection rules can be updated by changing the properties of the protection rule object with the rule's key specified in the key field.
|
|
1425
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1355
1426
|
* @param UpdateProtectionRulesRequest
|
|
1356
1427
|
* @return UpdateProtectionRulesResponse
|
|
1357
1428
|
* @throws OciError when an error occurs
|
|
1358
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1429
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateProtectionRules.ts.html |here} to see how to use UpdateProtectionRules API.
|
|
1359
1430
|
*/
|
|
1360
1431
|
updateProtectionRules(updateProtectionRulesRequest: requests.UpdateProtectionRulesRequest): Promise<responses.UpdateProtectionRulesResponse>;
|
|
1361
1432
|
/**
|
|
1362
1433
|
* 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.
|
|
1434
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1363
1435
|
* @param UpdateProtectionSettingsRequest
|
|
1364
1436
|
* @return UpdateProtectionSettingsResponse
|
|
1365
1437
|
* @throws OciError when an error occurs
|
|
1366
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1438
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateProtectionSettings.ts.html |here} to see how to use UpdateProtectionSettings API.
|
|
1367
1439
|
*/
|
|
1368
1440
|
updateProtectionSettings(updateProtectionSettingsRequest: requests.UpdateProtectionSettingsRequest): Promise<responses.UpdateProtectionSettingsResponse>;
|
|
1369
1441
|
/**
|
|
1370
1442
|
* 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.
|
|
1443
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1371
1444
|
* @param UpdateThreatFeedsRequest
|
|
1372
1445
|
* @return UpdateThreatFeedsResponse
|
|
1373
1446
|
* @throws OciError when an error occurs
|
|
1374
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1447
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateThreatFeeds.ts.html |here} to see how to use UpdateThreatFeeds API.
|
|
1375
1448
|
*/
|
|
1376
1449
|
updateThreatFeeds(updateThreatFeedsRequest: requests.UpdateThreatFeedsRequest): Promise<responses.UpdateThreatFeedsResponse>;
|
|
1377
1450
|
/**
|
|
1378
1451
|
* 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.
|
|
1379
1452
|
* 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`.
|
|
1380
1453
|
* The returned list will contain objects with `key` properties that can be used to update the resource during the `UpdateWaasPolicy` request.
|
|
1454
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1381
1455
|
* @param UpdateWaasPolicyRequest
|
|
1382
1456
|
* @return UpdateWaasPolicyResponse
|
|
1383
1457
|
* @throws OciError when an error occurs
|
|
1384
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1458
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateWaasPolicy.ts.html |here} to see how to use UpdateWaasPolicy API.
|
|
1385
1459
|
*/
|
|
1386
1460
|
updateWaasPolicy(updateWaasPolicyRequest: requests.UpdateWaasPolicyRequest): Promise<responses.UpdateWaasPolicyResponse>;
|
|
1387
1461
|
/**
|
|
1388
1462
|
* Updates the action for each specified custom protection rule. Only the `DETECT` and `BLOCK` actions can be set. Disabled rules should not be included in the list. For more information on protection rules, see [WAF Protection Rules](https://docs.cloud.oracle.com/iaas/Content/WAF/Tasks/wafprotectionrules.htm).
|
|
1463
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1389
1464
|
* @param UpdateWaasPolicyCustomProtectionRulesRequest
|
|
1390
1465
|
* @return UpdateWaasPolicyCustomProtectionRulesResponse
|
|
1391
1466
|
* @throws OciError when an error occurs
|
|
1392
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1467
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateWaasPolicyCustomProtectionRules.ts.html |here} to see how to use UpdateWaasPolicyCustomProtectionRules API.
|
|
1393
1468
|
*/
|
|
1394
1469
|
updateWaasPolicyCustomProtectionRules(updateWaasPolicyCustomProtectionRulesRequest: requests.UpdateWaasPolicyCustomProtectionRulesRequest): Promise<responses.UpdateWaasPolicyCustomProtectionRulesResponse>;
|
|
1395
1470
|
/**
|
|
1396
1471
|
* 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.
|
|
1472
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1397
1473
|
* @param UpdateWafAddressRateLimitingRequest
|
|
1398
1474
|
* @return UpdateWafAddressRateLimitingResponse
|
|
1399
1475
|
* @throws OciError when an error occurs
|
|
1400
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1476
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateWafAddressRateLimiting.ts.html |here} to see how to use UpdateWafAddressRateLimiting API.
|
|
1401
1477
|
*/
|
|
1402
1478
|
updateWafAddressRateLimiting(updateWafAddressRateLimitingRequest: requests.UpdateWafAddressRateLimitingRequest): Promise<responses.UpdateWafAddressRateLimitingResponse>;
|
|
1403
1479
|
/**
|
|
@@ -1410,10 +1486,11 @@ export declare class WaasClient {
|
|
|
1410
1486
|
The returned list will contain objects with `key` properties that can be used to update the
|
|
1411
1487
|
* resource during the `UpdateWafConfig` request.
|
|
1412
1488
|
*
|
|
1489
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1413
1490
|
* @param UpdateWafConfigRequest
|
|
1414
1491
|
* @return UpdateWafConfigResponse
|
|
1415
1492
|
* @throws OciError when an error occurs
|
|
1416
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1493
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateWafConfig.ts.html |here} to see how to use UpdateWafConfig API.
|
|
1417
1494
|
*/
|
|
1418
1495
|
updateWafConfig(updateWafConfigRequest: requests.UpdateWafConfigRequest): Promise<responses.UpdateWafConfigResponse>;
|
|
1419
1496
|
/**
|
|
@@ -1426,10 +1503,11 @@ export declare class WaasClient {
|
|
|
1426
1503
|
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.
|
|
1427
1504
|
* <p>
|
|
1428
1505
|
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.
|
|
1506
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1429
1507
|
* @param UpdateWhitelistsRequest
|
|
1430
1508
|
* @return UpdateWhitelistsResponse
|
|
1431
1509
|
* @throws OciError when an error occurs
|
|
1432
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
1510
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.7.0/waas/UpdateWhitelists.ts.html |here} to see how to use UpdateWhitelists API.
|
|
1433
1511
|
*/
|
|
1434
1512
|
updateWhitelists(updateWhitelistsRequest: requests.UpdateWhitelistsRequest): Promise<responses.UpdateWhitelistsResponse>;
|
|
1435
1513
|
}
|