Pakistan: Pakistan
Palestine: Palestine
Israel: Israel
-Iraq: Afghanistan
+Iraq: Iraq
+Afghanistan: Afghanistan
Libya: Libya
Turkey: Turkey
Thailand: Thailand
@@ -204,7 +205,8 @@Pakistan: Pakistan
Palestine: Palestine
Israel: Israel
-Iraq: Afghanistan
+Iraq: Iraq
+Afghanistan: Afghanistan
Libya: Libya
Turkey: Turkey
Thailand: Thailand
diff --git a/docs/wafd/api-ref/CreatePremiumHost.html b/docs/wafd/api-ref/CreatePremiumHost.html index c25d2a82e..11c6c7198 100644 --- a/docs/wafd/api-ref/CreatePremiumHost.html +++ b/docs/wafd/api-ref/CreatePremiumHost.html @@ -301,8 +301,7 @@Integer
WAF status of the protected domain name.
--1: Bypassed. Requests are directly sent to the backend servers without passing through WAF.
-0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. -1: Enabled. WAF detects attacks based on the configured policy.
+0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. -1: Enabled. WAF detects attacks based on the configured policy.
POST https://{Endpoint}/v1/{project_id}/premium-waf/host?enterprise_project_id=0
+Example Requests
POST https://{Endpoint}/v1/{project_id}/premium-waf/host?
{
"hostname" : "www.demo.com",
diff --git a/docs/wafd/api-ref/CreateWhiteblackipRule.html b/docs/wafd/api-ref/CreateWhiteblackipRule.html
index 415f09aab..03a35121c 100644
--- a/docs/wafd/api-ref/CreateWhiteblackipRule.html
+++ b/docs/wafd/api-ref/CreateWhiteblackipRule.html
@@ -83,7 +83,7 @@
name
No
+Yes
String
Content-Type
Yes
+No
String
Pakistan: Pakistan
Palestine: Palestine
Israel: Israel
-Iraq: Afghanistan
+Iraq: Iraq
+Afghanistan: Afghanistan
Libya: Libya
Turkey: Turkey
Thailand: Thailand
@@ -268,7 +269,7 @@
-Example Requests
DELETE https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}?enterprise_project_id=0
+Example Requests
DELETE https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}?
Example Responses
Status code: 200
Request succeeded.
diff --git a/docs/wafd/api-ref/DeletePremiumHost.html b/docs/wafd/api-ref/DeletePremiumHost.html
index ca6991496..bb525f816 100644
--- a/docs/wafd/api-ref/DeletePremiumHost.html
+++ b/docs/wafd/api-ref/DeletePremiumHost.html
@@ -131,8 +131,7 @@
Integer
WAF status of the protected domain name. The value can be:
--1: Bypassed. Requests are directly sent to the backend servers without passing through WAF.
-0: Suspended. WAF only forwards requests for the domain name but does not detect attacks.
+0: Suspended. WAF only forwards requests for the domain name but does not detect attacks.
1: Enabled. WAF detects attacks based on the configured policy.
Deleting a Reference Table
Function
This API is used to delete a reference table.
-URI
DELETE /v1/{project_id}/waf/valuelist/{table_id}
+URI
DELETE /v1/{project_id}/waf/valuelist/{valuelist_id}
Table 1 Path Parameters Parameter
Project ID
table_id
+valuelist_id
Yes
String
Reference table ID. It can be obtained by calling the API Querying the Reference Table List
+Valuelist ID. It can be obtained by calling the API Querying the Reference Table List
Content-Type
Yes
+No
String
Pakistan: Pakistan
Palestine: Palestine
Israel: Israel
-Iraq: Afghanistan
+Iraq: Iraq
+Afghanistan: Afghanistan
Libya: Libya
Turkey: Turkey
Thailand: Thailand
diff --git a/docs/wafd/api-ref/ListPremiumHost.html b/docs/wafd/api-ref/ListPremiumHost.html
index 04740b5fc..70ff307a0 100644
--- a/docs/wafd/api-ref/ListPremiumHost.html
+++ b/docs/wafd/api-ref/ListPremiumHost.html
@@ -189,8 +189,7 @@
Integer
WAF status of the protected domain name. The value can be:
--1: Bypassed. Requests are directly sent to the backend servers without passing through WAF.
-0: Suspended. WAF only forwards requests for the domain name but does not detect attacks.
+0: Suspended. WAF only forwards requests for the domain name but does not detect attacks.
1: Enabled. WAF detects attacks based on the configured policy.
Content-Type
Yes
+No
String
Content-Type
Yes
+No
String
Pakistan: Pakistan
Palestine: Palestine
Israel: Israel
-Iraq: Afghanistan
+Iraq: Iraq
+Afghanistan: Afghanistan
Libya: Libya
Turkey: Turkey
Thailand: Thailand
diff --git a/docs/wafd/api-ref/ShowValueList.html b/docs/wafd/api-ref/ShowValueList.html
index d80fe246f..7eced110f 100644
--- a/docs/wafd/api-ref/ShowValueList.html
+++ b/docs/wafd/api-ref/ShowValueList.html
@@ -1,9 +1,9 @@
-Querying a Reference Table by ID
-Function
This API is used to query a reference table by ID.
+Querying a Reference Table
+Function
This API is used to query a reference table.
-URI
GET /v1/{project_id}/waf/valuelist/{table_id}
+URI
GET /v1/{project_id}/waf/valuelist/{valuelist_id}
Table 1 Path Parameters Parameter
Project ID
table_id
+valuelist_id
Yes
String
Reference table ID. It can be obtained by calling the API Querying the Reference Table List
+Valuelist ID. It can be obtained by calling the API Querying the Reference Table List
Pakistan: Pakistan
Palestine: Palestine
Israel: Israel
-Iraq: Afghanistan
+Iraq: Iraq
+Afghanistan: Afghanistan
Libya: Libya
Turkey: Turkey
Thailand: Thailand
@@ -213,7 +214,8 @@
Pakistan: Pakistan
Palestine: Palestine
Israel: Israel
-Iraq: Afghanistan
+Iraq: Iraq
+Afghanistan: Afghanistan
Libya: Libya
Turkey: Turkey
Thailand: Thailand
diff --git a/docs/wafd/api-ref/UpdatePremiumHost.html b/docs/wafd/api-ref/UpdatePremiumHost.html
index feab7e206..b8da4a5a9 100644
--- a/docs/wafd/api-ref/UpdatePremiumHost.html
+++ b/docs/wafd/api-ref/UpdatePremiumHost.html
@@ -142,11 +142,20 @@
Integer
WAF status of the protected domain name.
--1: Bypassed. Requests are directly sent to the backend servers without passing through WAF.
-0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. -1: Enabled. WAF detects attacks based on the configured policy.
+0: Suspended. WAF only forwards requests for the domain name but does not detect attacks.
+1: Enabled. WAF detects attacks based on the configured policy.
server
+No
+Array of PremiumWafServer objects
+Server configuration in dedicated mode
+block_page
No
@@ -214,7 +223,7 @@
-Table 4 BlockPage Parameter
+Table 4 PremiumWafServer Parameter
Mandatory
template
+front_protocol
Yes
String
Template type. The value can be:
-default: The default block page is returned when a request is blocked.
-custom: Your custom block page is returned when a request is blocked.
-redirect: The request is redirected to the URL you specify.
+Client protocol
+Enumeration values:
+HTTP
+HTTPS
custom_page
+back_protocol
No
-CustomPage object
-Custom alarm page
-redirect_url
-No
+Yes
String
Redirection URL
+Server protocol
+Enumeration values:
+HTTP
+HTTPS
+
+address
+Yes
+String
+IP address or domain name of the origin server that the client accesses.
+port
+Yes
+Integer
+Server port
+type
+Yes
+String
+The origin server address is an IPv4 or IPv6 address. Default value: ipv4
+Enumeration values:
+ipv4
+ipv6
+
+vpc_id
+Yes
+String
+VPC ID. Perform the following steps to obtain the VPC ID:
+1.Find the name of the VPC where the dedicated engine is located. The VPC name is in the VPC\Subnet column. Log in to the WAF console and choose Instance Management > Dedicated Engine > VPC\Subnet.
+Log in to the VPC console and click the VPC name. On the page displayed, copy the VPC ID in the VPC Information area.
+
+weight
+No
+Integer
+This parameter is reserved and can be ignored currently.
-Table 5 CustomPage Parameter
+Table 5 BlockPage Parameter
Mandatory
status_code
+template
Yes
String
Status Codes
+Template type. The value can be:
+default: The default block page is returned when a request is blocked.
+custom: Your custom block page is returned when a request is blocked.
+redirect: The request is redirected to the URL you specify.
+
content_type
+custom_page
Yes
+No
String
+CustomPage object
Content type of alarm page
+Custom alarm page
content
+redirect_url
Yes
+No
String
Page content
+Redirection URL
-Table 6 Flag Parameter
+Table 6 CustomPage Parameter
Mandatory
pci_3ds
+status_code
No
+Yes
String
Whether to enable PCI 3DS compliance check. This parameter must be used together with tls and cipher. tls must be set to TLS v1.2, and cipher must be set to cipher_2. Note: If PCI 3DS compliance check is enabled and the minimum TLS is set to TLS v1.2, the website can be accessed using TLS v1.2, but cannot be accessed using TLS v1.1 or earlier. Once PCI 3DS is enabled, it cannot be disabled. Before you enable it, ensure that your website services will not be affected.
-true: Enable this check.
-false: Disable this check.
-
-Enumeration values:
-true
-false
-
+Status Codes
pci_dss
+content_type
No
+Yes
String
Whether to enable PCI DSS compliance check. This parameter must be used together with tls and cipher. tls must be set to TLS v1.2, and cipher must be set to cipher_2. Note: If PCI DSS compliance check is enabled and the minimum TLS is set to TLS v1.2, the website can be accessed using TLS v1.2, but cannot be accessed using TLS v1.1 or earlier. Before you enable it, ensure that your website services will not be affected.
-true: Enable this check.
-false: Disable this check.
-
-Enumeration values:
-true
-false
-
+Content type of alarm page
+content
+Yes
+String
+Page content
-Table 7 TrafficMark Parameter
+Table 7 Flag Parameter
Mandatory
sip
-No
-Array of strings
-IP tag. HTTP request header field of the original client IP address.
-cookie
+pci_3ds
No
String
Session tag. This tag is used by known attack source rules to block malicious attacks based on cookie attributes. This parameter must be configured in known attack source rules to block requests based on cookie attributes.
+Whether to enable PCI 3DS compliance check. This parameter must be used together with tls and cipher. tls must be set to TLS v1.2, and cipher must be set to cipher_2. Note: If PCI 3DS compliance check is enabled and the minimum TLS is set to TLS v1.2, the website can be accessed using TLS v1.2, but cannot be accessed using TLS v1.1 or earlier. Once PCI 3DS is enabled, it cannot be disabled. Before you enable it, ensure that your website services will not be affected.
+true: Enable this check.
+false: Disable this check.
+
+Enumeration values:
+true
+false
+
params
+pci_dss
No
String
User tag. This tag is used by known attack source rules to block malicious attacks based on params attributes. This parameter must be configured to block requests based on the params attributes.
+Whether to enable PCI DSS compliance check. This parameter must be used together with tls and cipher. tls must be set to TLS v1.2, and cipher must be set to cipher_2. Note: If PCI DSS compliance check is enabled and the minimum TLS is set to TLS v1.2, the website can be accessed using TLS v1.2, but cannot be accessed using TLS v1.1 or earlier. Before you enable it, ensure that your website services will not be affected.
+true: Enable this check.
+false: Disable this check.
+
+Enumeration values:
+true
+false
+
-Table 8 CircuitBreaker Parameter
+Table 8 TrafficMark Parameter
Mandatory
switch
+sip
No
Boolean
+Array of strings
Whether to enable connection protection.
-true: Enable connection protection.
-false: Disable the connection protection.
-
+IP tag. HTTP request header field of the original client IP address.
dead_num
+cookie
No
Integer
+String
502/504 error threshold. 502/504 errors allowed for every 30 seconds.
+Session tag. This tag is used by known attack source rules to block malicious attacks based on cookie attributes. This parameter must be configured in known attack source rules to block requests based on cookie attributes.
dead_ratio
+params
No
Number
+String
A breakdown protection is triggered when the 502/504 error threshold and percentage threshold have been reached.
-block_time
-No
-Integer
-Protection period upon the first breakdown. During this period, WAF stops forwarding client requests.
-superposition_num
-No
-Integer
-The maximum multiplier you can use for consecutive breakdowns. The number of breakdowns are counted from 0 every time the accumulated breakdown protection duration reaches 3,600s. For example, assume that Initial Downtime (s) is set to 180s and Multiplier for Consecutive Breakdowns is set to 3. If the breakdown is triggered for the second time, that is, less than 3, the protection duration is 360s (180s X 2). If the breakdown is triggered for the third or fourth time, that is, equal to or greater than 3, the protection duration is 540s (180s X 3). When the accumulated downtime duration exceeds 1 hour (3,600s), the number of breakdowns are counted from 0.
-suspend_num
-No
-Integer
-Threshold of the number of pending URL requests. Connection protection is triggered when the threshold has been reached.
-sus_block_time
-No
-Integer
-Downtime duration after the connection protection is triggered. During this period, WAF stops forwarding website requests.
+User tag. This tag is used by known attack source rules to block malicious attacks based on params attributes. This parameter must be configured to block requests based on the params attributes.
-Table 9 TimeoutConfig Parameter
+Table 9 CircuitBreaker Parameter
Mandatory
connect_timeout
+switch
No
Integer
+Boolean
Timeout for WAF to connect to the origin server.
+Whether to enable connection protection.
+true: Enable connection protection.
+false: Disable the connection protection.
+
send_timeout
+dead_num
No
Integer
Timeout for WAF to send requests to the origin server.
+502/504 error threshold. 502/504 errors allowed for every 30 seconds.
read_timeout
+dead_ratio
+No
+Number
+A breakdown protection is triggered when the 502/504 error threshold and percentage threshold have been reached.
+block_time
No
Integer
Timeout for WAF to receive responses from the origin server.
+Protection period upon the first breakdown. During this period, WAF stops forwarding client requests.
+superposition_num
+No
+Integer
+The maximum multiplier you can use for consecutive breakdowns. The number of breakdowns are counted from 0 every time the accumulated breakdown protection duration reaches 3,600s. For example, assume that Initial Downtime (s) is set to 180s and Multiplier for Consecutive Breakdowns is set to 3. If the breakdown is triggered for the second time, that is, less than 3, the protection duration is 360s (180s X 2). If the breakdown is triggered for the third or fourth time, that is, equal to or greater than 3, the protection duration is 540s (180s X 3). When the accumulated downtime duration exceeds 1 hour (3,600s), the number of breakdowns are counted from 0.
+suspend_num
+No
+Integer
+Threshold of the number of pending URL requests. Connection protection is triggered when the threshold has been reached.
+sus_block_time
+No
+Integer
+Downtime duration after the connection protection is triggered. During this period, WAF stops forwarding website requests.
+
+
+
+Table 10 TimeoutConfig Parameter
+Mandatory
+Type
+Description
+connect_timeout
+No
+Integer
+Timeout for WAF to connect to the origin server.
+send_timeout
+No
+Integer
+Timeout for WAF to send requests to the origin server.
+read_timeout
+No
+Integer
+Timeout for WAF to receive responses from the origin server.
Response Parameters
Status code: 200
-Table 10 Response body parameters Parameter
+Table 11 Response body parameters Parameter
Type
Integer
WAF status of the protected domain name. The value can be:
--1: Bypassed. Requests are directly sent to the backend servers without passing through WAF.
-0: Suspended. WAF only forwards requests for the domain name but does not detect attacks.
+0: Suspended. WAF only forwards requests for the domain name but does not detect attacks.
1: Enabled. WAF detects attacks based on the configured policy.
-Table 11 PremiumWafServer Parameter
+
-Table 12 Access_progress Parameter
+
-Table 13 Flag Parameter
+
-Table 14 BlockPage Parameter
+
-Table 15 CustomPage Parameter
+
-Table 16 Extend Parameter
+
-Table 17 TrafficMark Parameter
+
-Table 18 CircuitBreaker Parameter
+
-Table 19 TimeoutConfig Parameter
+Table 20 TimeoutConfig Parameter
Type
Status code: 400
-Table 20 Response body parameters Parameter
+Table 21 Response body parameters Parameter
Type
Status code: 401
-Table 21 Response body parameters Parameter
+Table 22 Response body parameters Parameter
Type
Status code: 500
-Table 22 Response body parameters Parameter
+Table 23 Response body parameters Parameter
Type
Modifying a Reference Table
Function
This API is used to modify a reference table.
-URI
PUT /v1/{project_id}/waf/valuelist/{table_id}
+URI
PUT /v1/{project_id}/waf/valuelist/{valuelist_id}
Table 1 Path Parameters Parameter
Project ID
table_id
+valuelist_id
Yes
String
Reference table ID. It can be obtained by calling the API Querying the Reference Table List
+Valuelist ID. It can be obtained by calling the API Querying the Reference Table List
Creating a Reference Table
-Querying a Reference Table by ID
+ Querying a Reference Table
Modifying a Reference Table
diff --git a/docs/wafd/api-ref/waf_02_0087.html b/docs/wafd/api-ref/waf_02_0087.html
index a7048f939..65802a70b 100644
--- a/docs/wafd/api-ref/waf_02_0087.html
+++ b/docs/wafd/api-ref/waf_02_0087.html
@@ -8,7 +8,12 @@
-2023-03-30
+2023-04-23
+Revised the document based on review comments.
+2023-03-30
- Added "Geographical Location Codes."
- Revised the document based on review comments.