url
diff --git a/docs/wafd/api-ref/CreateCcRule.html b/docs/wafd/api-ref/CreateCcRule.html
index 7d412fbc..f4c837c6 100644
--- a/docs/wafd/api-ref/CreateCcRule.html
+++ b/docs/wafd/api-ref/CreateCcRule.html
@@ -3,7 +3,7 @@
Creating a CC Attack Protection Rule
FunctionThis API is used to create a CC attack protection rule.
- URIPOST /v1/{project_id}/waf/policy/{policy_id}/cc
+ URIPOST /v1/{project_id}/waf/policy/{policy_id}/cc
Table 1 Path ParametersParameter
|
@@ -30,7 +30,7 @@
String
|
-Policy ID. It can be obtained by calling the API Querying Protection Policies.
+ | Policy ID. It can be obtained by calling the ListPolicy API.
|
|---|
@@ -81,7 +81,127 @@
-description
+ | mode
+ |
+Yes
+ |
+Integer
+ |
+Protection mode of the CC attack protection rule, which corresponds to the Mode field in the Add CC Attack Protection Rule dialog box on the WAF console.
+0: standard. Only the protected paths of domain names can be specified.
+1: The path, IP address, cookie, header, and params fields can all be set.
+
+Enumeration values:
+
+ |
+
+url
+ |
+Yes
+ |
+String
+ |
+Path to be protected in the CC attack protection rule. This parameter is mandatory when the CC attack protection rule is in standard mode (i.e. the value of mode is 0).
+ |
+
+conditions
+ |
+No
+ |
+Array of CcCondition objects
+ |
+Rate limit conditions of the CC protection rule. This parameter is mandatory when the CC protection rule is in advanced mode (i.e. the value of mode is 1).
+ |
+
+action
+ |
+Yes
+ |
+action object
+ |
+Protection action to take if the number of requests reaches the upper limit.
+ |
+
+tag_type
+ |
+Yes
+ |
+String
+ |
+Rate limit mode.
+ip: IP-based rate limiting. Website visitors are identified by IP address.
+cookie: User-based rate limiting. Website visitors are identified by the cookie key value.
+header: User-based rate limiting. Website visitors are identified by the header field.
+other: Website visitors are identified by the Referer field (user-defined request source).
+
+Enumeration values:
+ip
+cookie
+header
+other
+
+ |
+
+tag_index
+ |
+No
+ |
+String
+ |
+User identifier. This parameter is mandatory when the rate limit mode is set to user (cookie or header).
+cookie: Set the cookie field name. You need to configure an attribute variable name in the cookie that can uniquely identify a web visitor based on your website requirements. This field does not support regular expressions. Only complete matches are supported. For example, if a website uses the name field in the cookie to uniquely identify a website visitor, select name.
+header: Set the user-defined HTTP header you want to protect. You need to configure the HTTP header that can identify web visitors based on your website requirements.
+
+ |
+
+tag_condition
+ |
+No
+ |
+tag_condition object
+ |
+User tag. This parameter is mandatory when the rate limit mode is set to other. -other: A website visitor is identified by the Referer field (user-defined request source).
+ |
+
+limit_num
+ |
+Yes
+ |
+Integer
+ |
+Rate limit frequency based on the number of requests. The value ranges from 1 to 2,147,483,647.
+ |
+
+limit_period
+ |
+Yes
+ |
+Integer
+ |
+Rate limit period, in seconds. The value ranges from 1 to 3,600.
+ |
+
+unlock_num
+ |
+No
+ |
+Integer
+ |
+Allowable frequency based on the number of requests. The value ranges from 0 to 2,147,483,647. This parameter is required only when the protection action type is dynamic_block.
+ |
+
+lock_time
+ |
+No
+ |
+Integer
+ |
+Block duration, in seconds. The value ranges from 0 to 65,535. Specifies the period within which access is blocked. An error page is displayed in this period.
+ |
+
+description
|
No
|
@@ -90,84 +210,11 @@
Rule description
|
-limit_num
- |
-No
- |
-Integer
- |
-Frequency limits
-Minimum: 0
-Maximum: 10000
- |
-
-limit_period
- |
-No
- |
-Integer
- |
-Frequency limit unit
-Minimum: 0
-Maximum: 10000
- |
-
-url
- |
-No
- |
-String
- |
-url
-Minimum: 0
-Maximum: 10000
- |
-
-mode
- |
-No
- |
-Integer
- |
-Work mode. The value can be 0 (standard) or 1 (advanced). The parameters of the advanced mode cannot be described in the same document of the same API. For details, see this parameter on the console page.
-Enumeration values:
-
- |
-
-action
- |
-No
- |
-action object
- |
-Action to take if the number of requests reaches the upper limit.
- |
-
-tag_type
- |
-No
- |
-String
- |
-Protection mode.
-ip: IP-based rate limiting. Website visitors are identified by IP address.
-cookie: User-based rate limiting. Website visitors are identified by the cookie key value.
-other: Website visitors are identified by the Referer field (user-defined request source).
-
-Enumeration values:
-
- |
-
- Table 4 actionParameter
+Table 4 CcConditionParameter
|
Mandatory
|
@@ -179,34 +226,89 @@
|---|
category
|
-No
+ | Yes
|
String
|
-Action type:
-block: WAF blocks discovered attacks.
-captcha: Verification code. WAF requires visitors to enter a correct verification code to continue their access to requested page on your website.
-If tag_type is set to other, the value can only be block.
+Field type. The value can be url, ip, params, cookie, or header.
+Enumeration values:
+url
+ip
+params
+cookie
+header
|
|
-detail
+ | logic_operation
+ |
+Yes
+ |
+String
+ |
+Logic for matching the condition.
+If the category is url, the optional operations are contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, not_suffix, contain_any, not_contain_all, equal_any, not_equal_all, equal_any, not_equal_all, prefix_any, not_prefix_all, suffix_any, not_suffix_all, len_greater, len_less, len_equal and len_not_equal
+If the category is ip, the optional operations are: equal, not_equal, , equal_any and not_equal_all
+If the category is params, cookie and header, the optional operations are: contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, not_suffix, contain_any, not_contain_all, equal_any, not_equal_all, equal_any, not_equal_all, prefix_any, not_prefix_all, suffix_any, not_suffix_all, len_greater, len_less, len_equal, len_not_equal, num_greater, num_less, num_equal, num_not_equal, exist and not_exist
+
+Enumeration values:
+contain
+not_contain
+equal
+not_equal
+prefix
+not_prefix
+suffix
+not_suffix
+contain_any
+not_contain_all
+equal_any
+not_equal_all
+prefix_any
+not_prefix_all
+suffix_any
+not_suffix_all
+num_greater
+num_less
+num_equal
+num_not_equal
+exist
+not_exist
+
+ |
+
+contents
+ |
+No
+ |
+Array of strings
+ |
+Content of the conditions. This parameter is mandatory when the suffix of logic_operation is not any or all.
+ |
+
+value_list_id
|
No
|
String
|
-Action details. If detail is null, the default block page is displayed by default.
-
+ | Reference table ID. It can be obtained by calling the API Querying the Reference Table List. This parameter is mandatory when the suffix of logic_operation is any or all. The reference table type must be the same as the category type.
+ |
+
+index
+ |
+No
+ |
+String
+ |
+Subfield. When category is set to params, cookie, or header, set this parameter based on site requirements. This parameter is mandatory.
|
Table 5 detailParameter
+Table 5 actionParameter
|
Mandatory
|
@@ -216,20 +318,43 @@
|---|
-response
+ | category
+ |
+Yes
+ |
+String
+ |
+Action type:
+captcha: Verification code. WAF requires visitors to enter a correct verification code to continue their access to requested page on your website.
+block: WAF blocks the requests. When tag_type is set to other, the value can only be block.
+log: WAF logs the event only.
+dynamic_block: In the previous rate limit period, if the request frequency exceeds the value of Rate Limit Frequency, the request is blocked. In the next rate limit period, if the request frequency exceeds the value of Permit Frequency, the request is still blocked. Note: The dynamic_block protection action can be set only when the advanced protection mode is enabled for the CC protection rule.
+
+Enumeration values:
+captcha
+block
+log
+dynamic_block
+
+ |
+
+detail
|
No
|
-response object
+ | detail object
|
-Returned page.
+ | Block page information. When protection action category is set to block or dynamic_block, you need to set the returned block page.
+If you want to use the default block page, this parameter can be excluded.
+If you want to use a custom block page, set this parameter.
+
|
Table 6 responseParameter
+Table 6 detailParameter
|
Mandatory
|
@@ -239,22 +364,82 @@
|---|
-content_type
+ | response
|
No
|
-String
+ | response object
|
-Content type. The value can only be application/json, text/html, or text/xml.
+ | Returned page.
|
-content
+ |
+
+ Table 7 responseParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+content_type
|
-No
+ | No
|
-String
+ | String
|
-Protection page content.
+ | Content type. The value can only be application/json, text/html, or text/xml.
+Enumeration values:
+application/json
+text/html
+text/xml
+
+ |
+
+content
+ |
+No
+ |
+String
+ |
+Protection page content.
+ |
+
+
+
+ Table 8 tag_conditionParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+category
+ |
+No
+ |
+String
+ |
+User identifier. The value is fixed at referer.
+ |
+
+contents
+ |
+No
+ |
+Array of strings
+ |
+Content of the user identifier field.
|
@@ -263,7 +448,7 @@
Response ParametersStatus code: 200
- Table 7 Response body parametersParameter
+Table 9 Response body parametersParameter
|
Type
|
@@ -308,7 +493,7 @@
Mode.
0: Standard.
-1: Advanced
+1: Advanced.
|
|---|
@@ -322,36 +507,80 @@
-limit_num
+ | conditions
|
-String
+ | Array of CcCondition objects
|
-Number of requests allowed from a web visitor in a rate limiting period
+ | Rate limit conditions of the CC protection rule. This parameter is mandatory when the CC protection rule is in advanced mode (i.e. the value of mode is 1).
|
-limit_period
+ | action
|
-String
+ | action object
|
-Rate limiting period
- |
-
-lock_time
- |
-String
- |
-How long a web visitor will be locked The value range is [0 to 2^32), in seconds.
+ | Protection action to take if the number of requests reaches the upper limit.
|
tag_type
|
String
|
-Protection mode.
+ | Rate limit mode.
ip: IP-based rate limiting. Website visitors are identified by IP address.
cookie: User-based rate limiting. Website visitors are identified by the cookie key value.
-other: A website visitor is identified by the Referer field (user-defined request source).
+other: Website visitors are identified by the Referer field (user-defined request source).
+Enumeration values:
+ip
+other
+cookie
+header
+
+ |
+
+tag_index
+ |
+String
+ |
+User identifier. This parameter is mandatory when the rate limit mode is set to user (cookie or header).
+cookie: Set the cookie field name. You need to configure an attribute variable name in the cookie that can uniquely identify a web visitor based on your website requirements. This field does not support regular expressions. Only complete matches are supported. For example, if a website uses the name field in the cookie to uniquely identify a website visitor, select name.
+header: Set the user-defined HTTP header you want to protect. You need to configure the HTTP header that can identify web visitors based on your website requirements.
+
+ |
+
+tag_condition
+ |
+tag_condition object
+ |
+User tag. This parameter is mandatory when the rate limit mode is set to other. -other: A website visitor is identified by the Referer field (user-defined request source).
+ |
+
+limit_num
+ |
+Integer
+ |
+Rate limit frequency based on the number of requests. The value ranges from 1 to 2,147,483,647.
+ |
+
+limit_period
+ |
+Integer
+ |
+Rate limit period, in seconds. The value ranges from 1 to 3,600.
+ |
+
+unlock_num
+ |
+Integer
+ |
+Allowable frequency based on the number of requests. The value ranges from 0 to 2,147,483,647. This parameter is required only when the protection action type is dynamic_block.
+ |
+
+lock_time
+ |
+Integer
+ |
+Block duration, in seconds. The value ranges from 0 to 65,535. Specifies the period within which access is blocked. An error page is displayed in this period.
|
description
@@ -361,18 +590,32 @@
| Rule description
|
-action
+ | total_num
|
-action object
+ | Integer
|
-Action to take if the number of requests reaches the upper limit.
+ | This parameter is reserved and can be ignored currently.
|
-conditions
+ | unaggregation
|
-Array of conditions objects
+ | Boolean
|
-Condition list. This parameter is returned when mode is set to 1.
+ | This parameter is reserved and can be ignored currently.
+ |
+
+aging_time
+ |
+Integer
+ |
+Rule aging time. This parameter is reserved and can be ignored currently.
+ |
+
+producer
+ |
+Integer
+ |
+Rule creation object. This parameter is reserved and can be ignored currently.
|
timestamp
@@ -386,7 +629,7 @@
|
Table 8 actionParameter
+Table 10 CcConditionParameter
|
Type
|
@@ -398,28 +641,77 @@
String
|
-Action type:
-block: WAF blocks discovered attacks.
-captcha: Verification code. WAF requires visitors to enter a correct verification code to continue their access to requested page on your website.
-If tag_type is set to other, the value can only be block.
+Field type. The value can be url, ip, params, cookie, or header.
+Enumeration values:
+url
+ip
+params
+cookie
+header
|
|
|---|
-detail
+ | logic_operation
|
String
|
-Action details. If detail is null, the default block page is displayed by default.
-This parameter cannot be included when category is set to captcha.
-This parameter is required when category is set to block.
+Logic for matching the condition.
+If the category is url, the optional operations are contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, not_suffix, contain_any, not_contain_all, equal_any, not_equal_all, equal_any, not_equal_all, prefix_any, not_prefix_all, suffix_any, not_suffix_all, len_greater, len_less, len_equal and len_not_equal
+If the category is ip, the optional operations are: equal, not_equal, , equal_any and not_equal_all
+If the category is params, cookie and header, the optional operations are: contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, not_suffix, contain_any, not_contain_all, equal_any, not_equal_all, equal_any, not_equal_all, prefix_any, not_prefix_all, suffix_any, not_suffix_all, len_greater, len_less, len_equal, len_not_equal, num_greater, num_less, num_equal, num_not_equal, exist and not_exist
+Enumeration values:
+contain
+not_contain
+equal
+not_equal
+prefix
+not_prefix
+suffix
+not_suffix
+contain_any
+not_contain_all
+equal_any
+not_equal_all
+prefix_any
+not_prefix_all
+suffix_any
+not_suffix_all
+num_greater
+num_less
+num_equal
+num_not_equal
+exist
+not_exist
+
+ |
+
|
+contents
+ |
+Array of strings
+ |
+Content of the conditions. This parameter is mandatory when the suffix of logic_operation is not any or all.
+ |
+
+value_list_id
+ |
+String
+ |
+Reference table ID. It can be obtained by calling the API Querying the Reference Table List. This parameter is mandatory when the suffix of logic_operation is any or all. The reference table type must be the same as the category type.
+ |
+
+index
+ |
+String
+ |
+Subfield. When category is set to params, cookie, or header, set this parameter based on site requirements. This parameter is mandatory.
|
Table 9 detailParameter
+Table 11 actionParameter
|
Type
|
@@ -427,18 +719,39 @@
|---|
-response
+ | category
|
-response object
+ | String
|
-Returned page
+ | Action type:
+captcha: Verification code. WAF requires visitors to enter a correct verification code to continue their access to requested page on your website.
+block: WAF blocks the requests. When tag_type is set to other, the value can only be block.
+log: WAF logs the event only.
+dynamic_block: In the previous rate limit period, if the request frequency exceeds the value of Rate Limit Frequency, the request is blocked. In the next rate limit period, if the request frequency exceeds the value of Permit Frequency, the request is still blocked. Note: The dynamic_block protection action can be set only when the advanced protection mode is enabled for the CC protection rule.
+
+Enumeration values:
+captcha
+block
+log
+dynamic_block
+
+ |
+
+detail
+ |
+detail object
+ |
+Block page information. When protection action category is set to block or dynamic_block, you need to set the returned block page.
+If you want to use the default block page, this parameter can be excluded.
+If you want to use a custom block page, set this parameter.
+
|
Table 10 responseParameter
+Table 12 detailParameter
|
Type
|
@@ -446,25 +759,18 @@
|---|
-content_type
+ | response
|
-String
+ | response object
|
-Content type. The value can only be application/json, text/html, or text/xml.
- |
-
-content
- |
-String
- |
-Contents
+ | Block Page
|
Table 11 conditionsParameter
+Table 13 responseParameter
|
Type
|
@@ -472,39 +778,49 @@
|---|
-category
+ | content_type
|
String
|
-Field type. The options are as follows: ip, cookie, and url
- |
-
-index
- |
-String
- |
-Parameter description:
-When the field type is ip or url, the index parameter is not required.
-When the field type is cookie and the subfield is customized, the value of index is the customized subfield.
+Content type. The value can only be application/json, text/html, or text/xml.
+Enumeration values:
+application/json
+text/html
+text/xml
|
|
-logic_operation
+ | content
|
String
|
-Condition matching logic. The options are contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, not_suffix, equal_any, and not_equal_any, contain_any, and not_contain_any.
-When the field type is url, the following matching logics are supported: contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, and not_suffix.
-When the field type is ip, the following matching logics are supported: equal, not_equal, equal_any, and not_equal_any.
-When category is set to cookie, the following matching logics are supported: contain, not_contain, equal, not_equal. prefix, not_prefix, suffix, not_suffix, contain_any, and not_contain_any.
-
+ | Block page information.
|
-contents
+ |
+
+ Table 14 tag_conditionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+category
|
-Array of strings
+ | String
|
-Content of the conditions.
+ | User identifier. The value is fixed at referer.
+ |
+
+contents
+ |
+Array of strings
+ |
+Content of the user identifier field.
|
@@ -512,26 +828,26 @@
Status code: 400
-Table 12 Response body parametersParameter
+Table 15 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -539,26 +855,26 @@
Status code: 401
-Table 13 Response body parametersParameter
+Table 16 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -566,26 +882,26 @@
Status code: 500
-Table 14 Response body parametersParameter
+Table 17 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -609,7 +925,6 @@
Example ResponsesStatus code: 200
Request succeeded.
{
- "aging_time" : 0,
"description" : "",
"id" : "a5f3fd28db564696b199228f0ac346b2",
"limit_num" : 10,
@@ -622,7 +937,9 @@
"tag_type" : "ip",
"timestamp" : 1656494435686,
"total_num" : 0,
+ "aging_time" : 0,
"unaggregation" : false,
+ "producer" : 1,
"url" : "/path"
}
Creating a Certificate
FunctionThis API is used to create a certificate.
- URIPOST /v1/{project_id}/waf/certificate
+ URIPOST /v1/{project_id}/waf/certificate
Table 1 Path ParametersParameter
|
@@ -230,8 +230,8 @@
{
"name" : "demo",
- "content" : "-----BEGIN CERTIFICATE----- MIIDyzCCArOgAwIBAgIJAN5U0Z4Bh5ccMA0GCSqGSIb3DQEBCwUAMHwxCzAJBgNV BAYTAlpIMRIwEAYDVQQIDAlHVUFOR0RPTkcxETAPBgNVBAcMCERPTkdHVUFOMQ0w CwYDVQQKDARERUtFMQswCQYDVQQLDAJESzELMAkGA1UEAwwCT0QxHTAbBgkqhkiG 9w0BCQEWDk8IZC5odWF3ZWkuY29tMB4XDTIxMTExNTA4MTk0MVoXDTIyMTExNTA4 MTk0MVowfDELMAkGA1UEBhMCWkgxEjAQBgNVBAgMCUdVQU5HRE9ORzERMA8GA1UE BwwIRE9OR0dVQU4xDTALBgNVBAoMBERFS0UxCzAJBgNVBAsMAkRLMQswCQYDVQQD DAJPRDEdMBsGCSqGSIb3DQEJARYOTwhkLmh1YXdlaS5jb20wggEiMA0GCSqGSIb3 DQEBAQUAA4IBDwAwggEKAoIBAQDcoLFK62//r0RHFyweYBj97S4NsJ8Qj0RG+Y02 OgwhQmRiNNjubJwP8Nqqyd86zr+fsSQxKBaBCosn1PcN2Pj2vPJD6NEk4I6VdOWr /kFYMlOcimhSfW4wt6VakniOKIYGrCxxvQe1X2OyBxT+ocTLRgEIB8ZbvJyPNseg feLEUuPYRpQ5kXLgJH2/3NwZFOgBHVv/b07l4fR+sWJMnIA2yIjSBQ0DEAOSusXo FQ/WRbBRH7DrQmxGiXsq4VELEr9Nnc/Kywq+9pYi8L+mKeRL+lcMMbXC/3k6OfMB tVTiwcmS1Mkr3iG03i8u6H7RSvRwyBz9G9sE+tmJZTPH6lYtAgMBAAGjUDBOMB0G A1UdDgQWBBQprUUFXW+gIkpzXdrYlsWjfSahWjAfBgNVHSMEGDAWgBQprUUFXW+g IkpzXdrYlsWjfSahWjAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQA2 603KozsQoIKeLvqDJlcAXwWRfNW8SvlaSJAulhHgneMt9bQgIL+3PJWA/iMniOhU o/kVwkiUIcxw4t7RwP0hVms0OZw59MuqKd3oCSWkYO4vEHs3t40JDWnGDnmQ4sol RkOWJwL4w8tnPe3qY9JSupjlsu6Y1hlvKtEfN2vEKFnsuMhidkUpUAJWodHhWBQH wgIDo4/6yTnWZNGK8JDal86Dm5IchXea1EoYBJsHxiJb7HeWQlkre+MCYi1RHOin 4mIXTr0oT4/jWlgklSz6/ZhGRq+7W7tIl7cvzCe+4XsVZIenAcYoNd/WLfo91PD4 yAsRXrOjW1so1Bj0BkDz -----END CERTIFICATE-----",
- "key" : "-----BEGIN PRIVATE KEY----- MIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDcoLFK62//r0RH FyweYBj97S4NsJ8Qj0RG+Y02OgwhQmRiNNjubJwP8Nqqyd86zr+fsSQxKBaBCosn 1PcN2Pj2vPJD6NEk4I6VdOWr/kFYMlOcimhSfW4wt6VakniOKIYGrCxxvQe1X2Oy BxT+ocTLRgEIB8ZbvJyPNsegfeLEUuPYRpQ5kXLgJH2/3NwZFOgBHVv/b07l4fR+ sWJMnIA2yIjSBQ0DEAOSusXoFQ/WRbBRH7DrQmxGiXsq4VELEr9Nnc/Kywq+9pYi 8L+mKeRL+lcMMbXC/3k6OfMBtVTiwcmS1Mkr3iG03i8u6H7RSvRwyBz9G9sE+tmJ ZTPH6lYtAgMBAAECggEBAL+xZxm/QoqXT+2stoqV2GEYaMFASpRqxlocjZMmEE/9 jZa+cBWIjHhVPsjRqYFBDcHEebu0JwlrjcjIAvgnIvnO5XgXm1A9Q+WbscokmcX1 xCvpHgc+MDVn+uWdCd4KW5kEk4EnSsFN5iNSf+1VxNURN+gwSSp/0E+muwA5IISO G6HQ+p6qs52JAitX5t/7ruKoHYXJxBnf7TUs7768qrh++KPKpPlq044qoYlcGO1n 4urPBHuNLy04GgGw+vkaqjqOvZrNLVOMMaFWBxsDWBehgSSBQTj+f3NCxneGYtt8 3SCTZQI5nIkb+r/M455EwKTSXuEsNHoIwx7L6GEPbQECgYEA8IxgK2fYykloICoh TFJaRAvyjyKa2+Aza4qT9SGY9Y30VPClPjBB1vUu5M9KrFufzlv06nGEcHmpEwOe 8vbRu7nLAQTGYFi8VK63q8w6FlFdAyCG6Sx+BWCfWxJzXsZLAJTfklwi8HsOSlqh 6QNv0xbE2fLjXKf8MHvtrufip40CgYEA6sy87eDrkVgtq4ythAik3i1C5Z3v0fvx mTblG52Z21OyocNq3Tf/b1ZwoIc1ik6cyBzY6z1bIrbSzArCqm0sb2iD+kJL81O0 /qqdXjBxZUkKiVAMNNp7xJGZHHFKWUxT2+UX/tlyx4tT4dzrFIkdDXkcMmqfsRxd 1NEVaAaT8SECgYAoU7BPtpIun43YTpfUfr3pSIN6oZeKoxSbw9i4MNC+4fSDRPC+ 80ImcmZRL7taF+Y7p0jxAOTuIkdJC8NbAiv5J9WzrwQ+5MF2BPB/2bYnRa6tNofH kZDy/9bXYsl6qw2p5Ety8wVcgZTMvFMGiG/32IpZ65FYWEU8L5qSRwfFhQKBgQC9 ihjZTj/bTHtRiHZppzCvyYm/Igd+Uwtsy0uXR1n0G1SQENgrTBD/J6AzdfJae6tE P0U8YIM5Oqxf2i/as9ay+IPRecMl4eSxz7jJWAGx6Yx/3AZ+hAB1ZbNbqniCLYNk d0MvjwmA25ATO+ro4OZ7AdEpQbk3l9aG/WFyYBz9AQKBgQCucFPA1l5eslL8196V WMr2Qo0tqzl7CGSoWQk2Sa2HZtZdfofXAaaqo+zvJ6RPHtJh0jgJtx536DVV3egI 37YrdQyJbCPZXQ3SPgqWCorUnXBwq/nxS06uwu6JBxUFc57ijmMU4fWYNrvkkmWb 7keAg/r5Uy1joMAvBN1I6lB8pg== -----END PRIVATE KEY-----"
+ "content" : "-----BEGIN CERTIFICATE-----\nMIICUjCCAbugAwIBAgIJANxRp4YpWj66MA0GCSqGSIb3DQEBCwUAMEIxCzAJBgNV BAYTAlhYMRUwEwYDVQQHDAxEZWZhdWx0IENpdHkxHDAaBgNVBAoME0RlZmF1bHQg Q29tcGFueSBMdGQwHhcNMjMwMzA2MTMwNDI2WhcNMjQwMzA1MTMwNDI2WjBCMQsw CQYDVQQGEwJYWDEVMBMGA1UEBwwMRGVmYXVsdCBDaXR5MRwwGgYDVQQKDBNEZWZh dWx0IENvbXBhbnkgTHRkMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC4KoXA HK8ZcmOMl+FDDnzBKhD/RcSdjqtie47YZYX9T9XNtfuvmJf78JQC3X18xAJdutyP tvX6RwqITLItD6DsI/x6vkMJDLGOfuMpxjHwm6VOILIVIMUVWsZqTk4NdaFRpBCN VpzQdy/j3WUg0l86dYna0GdkOHuk6l1pgk52RwIDAQABo1AwTjAdBgNVHQ4EFgQU 9/usGS95WL1qUuq5F8XiDXA8Fq4wHwYDVR0jBBgwFoAU9/usGS95WL1qUuq5F8Xi DXA8Fq4wDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsFAAOBgQCXIvTibia/fGlf IaraBMH313Z+xBlkBX5X8y2wYRa+RRVR4OB8zTY2Rm0OXOHMgPPEs5xpYXPBK/CH i+kodHIq+0AxYzMlDs3j+V7FzUrZQbItPYXtgQStZjdOvtM129ecuKWRRtmNNSBZ sj9VBsvsMrI1S2bZo5wJMPuR/TGGOQ==\n-----END CERTIFICATE-----",
+ "key" : "-----BEGIN PRIVATE KEY-----\nMIICeAIBADANBgkqhkiG9w0BAQEFAASCAmIwggJeAgEAAoGBALgqhcAcrxlyY4yX 4UMOfMEqEP9FxJ2Oq2J7jthlhf1P1c21+6+Yl/vwlALdfXzEAl263I+29fpHCohM si0PoOwj/Hq+QwkMsY5+4ynGMfCbpU4gshUgxRVaxmpOTg11oVGkEI1WnNB3L+Pd ZSDSXzp1idrQZ2Q4e6TqXWmCTnZHAgMBAAECgYEAh/YknirO/ktbwQzTqczFP1oO CFd6ixMr5d3wHEP/Qn6xCliCwiU2dzIqI19faD/Qu1/bu2HIgQf3d56fn/K8yrgq tmd7BZvXcZuK/LXOLfpAXAdMl5bgOW+ejJvf9LsA6xYWsxmki6+VYbJ+XVr4w2yH nBiimwp7v4eoBlMqVQECQQDeJw6o15p30MEzj5t3oVLL86rY20HZfqnpS6S10CHx l0W/0ah7S4QnvXi6NhvS0o3mj+VNzeYvoHII9DP28IyBAkEA1DnSyH7D5W4GUmsr NfDOBYuKUaahDtdN/Qx2JF1jEvLluLC7Nr1ETzrKodN/+lOYwfIOWx5tkXPpLFMu rko+xwJAWV7DEf+yn7L2loSWWbknsu7y80y5oALJ3hXVTGNP1H4zzChPLFLD9qzN rbPo25ZjCbcn23YSvWRBnAKKCTTagQJBAKWvgxVOimfrLvpXesPA/Ucs+s7mNSVe CCAAA5g+ZGPdyGUZbP++Yb8tWhdfBLINY9w+uuB+b/I3uRoG0xH1Gu8CQQCpEIYC DUNO98ylm4QOAkyC0nv6x33gQqcu6ExtK7ptbdFZT1QdOAwm5SBaE50rWjyTO4gL Cpsd6f0baeGAxNAw\n-----END PRIVATE KEY-----"
}
Example ResponsesStatus code: 200
diff --git a/docs/wafd/api-ref/CreateCustomRules.html b/docs/wafd/api-ref/CreateCustomRules.html
index 23996aa9..989775ba 100644
--- a/docs/wafd/api-ref/CreateCustomRules.html
+++ b/docs/wafd/api-ref/CreateCustomRules.html
@@ -3,7 +3,7 @@
Creating a Precise Protection Rule
FunctionThis API is used to create a precise protection rule.
- URIPOST /v1/{project_id}/waf/policy/{policy_id}/custom
+ URIPOST /v1/{project_id}/waf/policy/{policy_id}/custom
Table 1 Path ParametersParameter
|
@@ -30,7 +30,7 @@
String
|
-Policy ID. It can be obtained by calling the API Querying Protection Policies.
+ | Policy ID. It can be obtained by calling the ListPolicy API.
|
|---|
@@ -83,7 +83,7 @@
time
|
-No
+ | Yes
|
Boolean
|
@@ -131,7 +131,7 @@
action
|
-No
+ | Yes
|
CustomAction object
|
@@ -140,7 +140,7 @@
priority
|
-No
+ | Yes
|
Integer
|
@@ -168,6 +168,18 @@
String
|
Field type. The options are url, user-agent, ip, params, cookie, referer, header, request_line, method, and request.
+Enumeration values:
+url
+user-agent
+referer
+ip
+method
+request_line
+request
+params
+cookie
+header
+
|
index
@@ -178,7 +190,7 @@
|
Subfield
When the field type is url, user-agent, ip, refer, request_line, method, or request, index is not required.
-If the field type is params, header, or cookie, and the subfield is customized, the value of index is the customized subfield.
+When the field type is params, header, or cookie, and the subfield is customized, the value of index is the customized subfield.
|
@@ -188,7 +200,37 @@
String
|
-Logic for matching the condition. The options are contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, and not_suffix. For more details, see the console UI.
+ | Logic for matching the condition.
+If the category is url, user-agent or referer , the optional operations are contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, not_suffix, contain_any, not_contain_all, equal_any, not_equal_all, equal_any, not_equal_all, prefix_any, not_prefix_all, suffix_any, not_suffix_all, len_greater, len_less, len_equal and len_not_equal
+If the category is ip, the optional operations are: equal, not_equal, , equal_any and not_equal_all
+If the category is method, the optional operations are: equal and not_equal
+If the category is request_line and request, the optional operations are: len_greater, len_less, len_equal and len_not_equal
+If the category is params, header, and cookie, the optional operations are: contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, not_suffix, contain_any, not_contain_all, equal_any, not_equal_all, equal_any, not_equal_all, prefix_any, not_prefix_all, suffix_any, not_suffix_all, len_greater, len_less, len_equal, len_not_equal, num_greater, num_less, num_equal, num_not_equal, exist and not_exist
+
+Enumeration values:
+contain
+not_contain
+equal
+not_equal
+prefix
+not_prefix
+suffix
+not_suffix
+contain_any
+not_contain_all
+equal_any
+not_equal_all
+prefix_any
+not_prefix_all
+suffix_any
+not_suffix_all
+num_greater
+num_less
+num_equal
+num_not_equal
+exist
+not_exist
+
|
contents
@@ -197,7 +239,7 @@
|
Array of strings
|
-Condition content for matching the rule
+ | Content of the conditions. This parameter is mandatory when the suffix of logic_operation is not any or all.
|
value_list_id
@@ -206,7 +248,7 @@
|
String
|
-ID of the reference table
+ | Reference table ID. It can be obtained by calling the API Querying the Reference Table List. This parameter is mandatory when the suffix of logic_operation is any or all. The reference table type must be the same as the category type.
|
@@ -225,14 +267,29 @@
category
|
+Yes
+ |
+String
+ |
+Operation type
+block: WAF blocks attacks.
+pass: WAF allows requests.
+log: WAF only logs detected attacks.
+
+Enumeration values:
+
+ |
+
+followed_action_id
+ |
No
|
String
|
-Action type.
-
+ | ID of a known attack source rule. This parameter can be configured only when category is set to block.
|
@@ -294,13 +351,6 @@
Protective action of the precise protection rule.
|
-action_mode
- |
-Boolean
- |
-This parameter is reserved and can be ignored.
- |
-
priority
|
Integer
@@ -329,6 +379,27 @@
| Timestamp (ms) when the precise protection rule expires. This parameter is returned only when time is true.
|
+action_mode
+ |
+Boolean
+ |
+This parameter is reserved and can be ignored currently.
+ |
+
+aging_time
+ |
+Integer
+ |
+Rule aging time. This parameter is reserved and can be ignored currently.
+ |
+
+producer
+ |
+Integer
+ |
+Rule creation object. This parameter is reserved and can be ignored currently.
+ |
+
@@ -346,6 +417,18 @@
String
|
Field type. The options are url, user-agent, ip, params, cookie, referer, header, request_line, method, and request.
+Enumeration values:
+url
+user-agent
+ip
+params
+cookie
+referer
+header
+request_line
+method
+request
+
|
|---|
index
@@ -354,7 +437,7 @@
|
Subfield
When the field type is url, user-agent, ip, refer, request_line, method, or request, index is not required.
-If the field type is params, header, or cookie, and the subfield is customized, the value of index is the customized subfield.
+When the field type is params, header, or cookie, and the subfield is customized, the value of index is the customized subfield.
|
@@ -362,7 +445,35 @@
String
|
-Logic for matching the condition. The options are contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, and not_suffix. For more details, see the console UI.
+ | Logic for matching the condition.
+Enumeration values:
+contain
+not_contain
+equal
+not_equal
+prefix
+not_prefix
+suffix
+not_suffix
+contain_any
+not_contain_all
+equal_any
+not_equal_all
+prefix_any
+not_prefix_all
+suffix_any
+not_suffix_all
+len_greater
+len_less
+len_equal
+len_not_equal
+num_greater
+num_less
+num_equal
+num_not_equal
+exist
+not_exist
+
|
contents
@@ -372,6 +483,13 @@
| Content of the conditions.
|
+value_list_id
+ |
+String
+ |
+Reference table ID. It can be obtained by calling the API Querying the Reference Table List. This parameter is available only when a reference table is used when a protection rule is created.
+ |
+
@@ -388,10 +506,23 @@
String
|
- Action type.
-block: WAF blocks attacks.
-pass: WAF allows requests.
+Operation type
+block: WAF blocks attacks.
+pass: WAF allows requests.
+log: WAF only logs detected attacks.
+Enumeration values:
+
+ |
+
+followed_action_id
+ |
+String
+ |
+ID of a known attack source rule. This parameter can be configured only when category is set to block.
|
@@ -482,45 +613,41 @@
Example RequestsPOST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/custom?enterprise_project_id=0
{
- "description": "",
- "action": {
- "category": "block"
- },
- "priority": 50,
- "conditions": [
- {
- "category": "header",
- "logic_operation": "contain",
- "index": "demo"
- "content" ["demo"]
- }
- ],
- "time": false
+ "action" : {
+ "category" : "block"
+ },
+ "time" : false,
+ "priority" : 50,
+ "description" : "",
+ "conditions" : [ {
+ "category" : "url",
+ "logic_operation" : "contain",
+ "index" : null,
+ "contents" : [ "test" ]
+ } ]
}
Example ResponsesStatus code: 200
Request succeeded.
{
- "items" : [ {
- "action" : {
- "category" : "block"
- },
- "action_mode" : false,
- "aging_time" : 0,
- "conditions" : [ {
- "category" : "header",
- "index" : "demo",
- "logic_operation" : "contain",
- "content" : [ "demo" ]
- } ],
- "description" : "",
- "id" : "2a3caa2bc9814c09ad73d02e3485b4a4",
- "policyid" : "1f016cde588646aca3fb19f277c44d03",
- "priority" : 50,
- "status" : 1,
- "time" : false,
- "timestamp" : 1656495488880
- } ]
+ "id" : "88e8bf4158324b2d9a233e7ffb95516d",
+ "policyid" : "dde63c25e8394b21b16a2a49a99e659b",
+ "timestamp" : 1678799936830,
+ "description" : "",
+ "status" : 1,
+ "time" : false,
+ "priority" : 50,
+ "action_mode" : false,
+ "conditions" : [ {
+ "category" : "url",
+ "contents" : [ "test" ],
+ "logic_operation" : "contain"
+ } ],
+ "action" : {
+ "category" : "block"
+ },
+ "producer" : 1,
+ "aging_time" : 0
}
Status Codes
diff --git a/docs/wafd/api-ref/CreateGeoipRule.html b/docs/wafd/api-ref/CreateGeoipRule.html
index 8cff34d2..44911220 100644
--- a/docs/wafd/api-ref/CreateGeoipRule.html
+++ b/docs/wafd/api-ref/CreateGeoipRule.html
@@ -3,7 +3,7 @@
Creating a Geolocation Access Control Rule
FunctionThis API is used to create a geolocation access control rule.
- URIPOST /v1/{project_id}/waf/policy/{policy_id}/geoip
+ URIPOST /v1/{project_id}/waf/policy/{policy_id}/geoip
Table 1 Path ParametersParameter
|
@@ -30,7 +30,7 @@
String
|
-Policy ID
+ | Policy ID. It can be obtained by calling the ListPolicy API.
|
|---|
@@ -109,6 +109,7 @@
South Africa: South Africa
Mexico: Mexico
Peru: Peru
+For more geographical location codes, see "Appendix - Geographic Location Codes."
name
+ |
+No
+ |
+String
+ |
+Rule name. Currently, the console does not support configuring names for geolocation access control rule. Ignore this parameter.
+ |
+
description
|
No
@@ -162,6 +172,20 @@
| Policy ID
|
+name
+ |
+String
+ |
+Rule name. Currently, the console does not support configuring names for geolocation access control rule. Ignore this parameter.
+ |
+
+geoTagList
+ |
+Array of strings
+ |
+List of geographical locations hit the geolocation access control rule.
+ |
+
geoip
|
String
@@ -188,6 +212,7 @@
South Africa: South Africa
Mexico: Mexico
Peru: Peru
+For more geographical location codes, see "Appendix - Geographic Location Codes."
|
@@ -327,9 +352,9 @@
"timestamp" : 1650534513775,
"description" : "demo",
"status" : 1,
+ "geoTagList" : [ "BR" ],
"geoip" : "BR",
- "white" : 0,
- "geoTagList" : [ "SH", "Afghanistan" ]
+ "white" : 0
}
Status Codes
diff --git a/docs/wafd/api-ref/CreateIgnoreRule.html b/docs/wafd/api-ref/CreateIgnoreRule.html
index 61e47e85..fc7d9ed4 100644
--- a/docs/wafd/api-ref/CreateIgnoreRule.html
+++ b/docs/wafd/api-ref/CreateIgnoreRule.html
@@ -1,9 +1,9 @@
- Creating a False Alarm Masking Rule
- FunctionThis API is used to create a false alarm masking rule.
+ Creating a Global Protection Whitelist (Formerly False Alarm Masking) Rule
+ FunctionThis API is used to create a global protection whitelist (formerly false alarm masking) rule.
- URIPOST /v1/{project_id}/waf/policy/{policy_id}/ignore
+ URIPOST /v1/{project_id}/waf/policy/{policy_id}/ignore
Table 1 Path ParametersParameter
|
@@ -30,7 +30,7 @@
String
|
-Policy ID
+ | Policy ID. It can be obtained by calling the ListPolicy API.
|
|---|
@@ -81,22 +81,31 @@
-description
- |
-No
- |
-String
- |
-Provides supplementary information about the assignment.
- |
-
-url
+ | domain
|
Yes
|
-String
+ | Array of strings
|
-URL protected by the web tamper protection rule. The value must be in the standard URL format, for example, /admin.
+ | Domain names to be protected. If the array length is 0, this rule will take effect for all domain names that are protected by the policies this rule belongs to.
+ |
+
+conditions
+ |
+Yes
+ |
+Array of CreateCondition objects
+ |
+Condition list
+ |
+
+mode
+ |
+Yes
+ |
+Integer
+ |
+The value is fixed at 1, indicating v2 false alarm masking rules.
|
rule
@@ -105,57 +114,37 @@
|
String
|
-Masked rule. The value can be the ID of a rule that is matched, all rules (all), or enumeration value of the attack type. To mask a built-in rule included in Basic Web Protection, set this parameter to the ID of the rule. To obtain the rule ID, go to the WAF console. Then, choose Policies and click the policy name. On the displayed page, find the Basic Web Protection area and click Advanced Settings. On the displayed page, click Protection Rule and view the rule ID. To disable a certain type of rule, the value can be:
-xss or sqli: XSS attacks
-cmdi: Command injectionrobot: Malicious crawlers
-lfi: Local file inclusion
-rfi: Remote file inclusionwebshell: Website Trojans
-cc: CC attacks -custom_custom: Precise protection
-custom_whiteblackip: IP address blacklist and whitelist
-custom_geoip: Geolocation access control
-antitamper: Web tamper protection
-anticrawler: Anti-crawler protection
-leakage: Data leakage prevention
-illegal: Illegal requests
-vuln: Other attack types
+Items to be masked. You can provide multiple items and separate them with semicolons (;).
+If you want to disable a specific built-in rule for a domain name, the value of this parameter is the rule ID. When requests are blocked against a certain built-in rule while you do not want this rule to block requests later, you can query the rule in the Events page on the console and find its rule ID in the Hit Rule column. Then, you can disk the rule by its ID (including 6 digits).
+If you want to mask a type of basic web protection rules, set this parameter to the name of the type of basic web protection rules. xss: XSS attacks webshell: Web shells vuln: Other types of attacks sqli: SQL injection attack robot: Malicious crawlers rfi: Remote file inclusion lfi: Local file inclusion cmdi: Command injection attack
+To bypass the basic web protection, set this parameter to all.
+To bypass all WAF protection, set this parameter to bypass.
|
|
-url_logic
- |
-Yes
- |
-String
- |
-URL match logic:
-equal: full match
-prefix: prefix match
-
- |
-
-domains
- |
-No
- |
-Array of strings
- |
-Protected domain name
- |
-
advanced
|
No
|
-advanced object
+ | Array of Advanced objects
|
-advanced
+ | To ignore attacks of a specific field, specify the field in the Advanced settings area. After you add the rule, WAF will stop blocking attacks of the specified field. This parameter is not included if all modules are bypassed.
+ |
+
+description
+ |
+No
+ |
+String
+ |
+Description of the rule
|
- Table 4 advancedParameter
+Table 4 CreateConditionParameter
|
Mandatory
|
@@ -165,28 +154,82 @@
|---|
-index
+ | category
|
No
|
String
|
-To ignore attacks of a specified field, specify the field in the Advanced Settings area. After you complete the configuration, WAF will stop intercepting attack events of the specified field. The following fields are supported:
-cookie: session cookie
-header: header field
-body: body field
-multipart: multipart/form-data type data
-params: parameter
+Field type. The value can be url, ip, params, cookie, or header.
+Enumeration values:
+url
+ip
+params
+cookie
+header
|
|
-content
+ | contents
+ |
+No
+ |
+Array of strings
+ |
+Content. The array length is limited to 1. The content format varies depending on the field type. For example, if the field type is ip, the value must be an IP address or IP address range. If the field type is url, the value must be in the standard URL format. IF the field type is params, cookie, or header, the content format is not limited.
+ |
+
+logic_operation
|
No
|
String
|
-Specified field (available only for param, cookie, and header)
+ | The matching logic varies depending on the field type. For example, if the field type is ip, the logic can be equal or not_equal. If the field type is url, params, cookie, or header, the logic can be equal, not_equal, contain, not_contain, prefix, not_prefix, suffix, not_suffix.
+ |
+
+index
+ |
+No
+ |
+String
+ |
+If the field type is ip and the subfield is the client IP address, the index parameter is not required. If the subfield type is X-Forwarded-For, the value is x-forwarded-for; If the field type is params, header, or cookie, and the subfield is user-defined, the value of index is the user-defined subfield.
+ |
+
+
+
+ Table 5 AdvancedParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+index
+ |
+No
+ |
+String
+ |
+Field type. The following field types are supported: Params, Cookie, Header, Body, and Multipart.
+When you select Params, Cookie, or Header, you can set this parameter to all or configure subfields as required.
+When you select Body or Multipart, set this parameter to all.
+
+ |
+
+contents
+ |
+No
+ |
+Array of strings
+ |
+Subfield of the specified field type. The default value is all.
|
@@ -195,7 +238,7 @@
Response ParametersStatus code: 200
- Table 5 Response body parametersParameter
+Table 6 Response body parametersParameter
|
Type
|
@@ -207,96 +250,85 @@
String
|
-Rule ID.
+ | Rule ID
|
|---|
policyid
|
String
|
-Policy ID.
+ | Policy ID
|
timestamp
|
Long
|
-Rule creation time.
+ | Timestamp the rule was created.
|
description
|
String
|
-Provides supplementary information about the assignment.
+ | Rule Description
|
status
|
Integer
|
-Rule status. The value can be:
- |
-url
- |
-String
- |
-URL protected by the web tamper protection rule. The value must be in the standard URL format, for example, /admin.
- |
-
rule
|
String
|
-Masked rule. The value can be the ID of a rule that is matched, all rules (all), or enumeration value of the attack type. To mask a built-in rule included in Basic Web Protection, set this parameter to the ID of the rule. To obtain the rule ID, go to the WAF console. Then, choose Policies and click the policy name. On the displayed page, find the Basic Web Protection area and click Advanced Settings. On the displayed page, click Protection Rule and view the rule ID. To disable a certain type of rule, the value can be:
-xss or sqli: XSS attacks
-cmdi: Command injectionrobot: Malicious crawlers
-lfi: Local file inclusion
-rfi: Remote file inclusionwebshell: Website Trojans
-cc: CC attacks -custom_custom: Precise protection
-custom_whiteblackip: IP address blacklist and whitelist
-custom_geoip: Geolocation access control
-antitamper: Web tamper protection
-anticrawler: Anti-crawler protection
-leakage: Data leakage prevention
-illegal: Illegal requests
-vuln: Other attack types
+Items to be masked. You can provide multiple items and separate them with semicolons (;).
+If you want to disable a specific built-in rule for a domain name, the value of this parameter is the rule ID. When requests are blocked against a certain built-in rule while you do not want this rule to block requests later, you can query the rule in the Events page on the console and find its rule ID in the Hit Rule column. Then, you can disk the rule by its ID (including 6 digits).
+If you want to mask a type of basic web protection rules, set this parameter to the name of the type of basic web protection rules. xss: XSS attacks webshell: Web shells vuln: Other types of attacks sqli: SQL injection attack robot: Malicious crawlers rfi: Remote file inclusion lfi: Local file inclusion cmdi: Command injection attack
+To bypass the basic web protection, set this parameter to all.
+To bypass all WAF protection, set this parameter to bypass.
|
|
-url_logic
+ | mode
|
-String
+ | Integer
|
-URL match logic:
-equal: full match
-prefix: prefix match
-
+ | The value is fixed at 1, indicating v2 false alarm masking rules are used.
|
-domains
+ | conditions
|
-Array of strings
+ | Array of Condition objects
|
-Protected domain name
+ | Condition list
|
advanced
|
-advanced object
+ | Array of Advanced objects
|
-advanced
+ | Advanced settings
+ |
+
+domain
+ |
+Array of strings
+ |
+Domain names to be protected. If the array length is 0, this rule will take effect for all domain names that are protected by the policies this rule belongs to.
|
Table 6 advancedParameter
+Table 7 ConditionParameter
|
Type
|
@@ -304,24 +336,68 @@
|---|
-index
+ | category
|
String
|
-To ignore attacks of a specified field, specify the field in the Advanced Settings area. After you complete the configuration, WAF will stop intercepting attack events of the specified field. The following fields are supported:
-cookie: session cookie
-header: header field
-body: body field
-multipart: multipart/form-data type data
-params: parameter
+Field type. The value can be ip, url, params, cookie, or header.
+ |
+
|
+contents
+ |
+Array of strings
+ |
+Content. The array length must be 1. The content format varies depending on field types. For example, if the field type is ip, the value must be an IP address or IP address range. If the field type is url, the value must be a URL in standard format. If the field type is params, cookie, or header, the content format is not limited.
+ |
+
+logic_operation
+ |
+String
+ |
+The matching logic varies depending on the field type. For example, if the field type is ip, the logic can be equal or not_equal. If the field type is url, params, cookie, or header, the logic can be equal, not_equal, contain, not_contain, prefix, not_prefix, suffix, not_suffix.
+ |
+
+check_all_indexes_logic
+ |
+Integer
+ |
+This parameter is reserved and can be ignored.
+ |
+
+index
+ |
+String
+ |
+If the field type is ip and the subfield is the client IP address, the index parameter does not exist. If the subfield type is X-Forwarded-For, the value is x-forwarded-for. If the field type is params, header, or cookie, and the subfield is user-defined, the value of index is the user-defined subfield.
+ |
+
+
+
+ Table 8 AdvancedParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+index
+ |
+String
+ |
+Field type. The following field types are supported: Params, Cookie, Header, Body, and Multipart.
+When you select Params, Cookie, or Header, you can set this parameter to all or configure subfields as required.
+When you select Body or Multipart, set this parameter to all.
|
-content
+ | contents
|
-String
+ | Array of strings
|
-Specified field (available only for param, cookie, and header)
+ | Subfield of the specified field type. The default value is all.
|
@@ -329,26 +405,26 @@
Status code: 400
-Table 7 Response body parametersParameter
+Table 9 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -356,26 +432,26 @@
Status code: 401
-Table 8 Response body parametersParameter
+Table 10 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -383,26 +459,26 @@
Status code: 500
-Table 9 Response body parametersParameter
+Table 11 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -412,25 +488,34 @@
Example RequestsPOST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/ignore?
{
- "domain" : [ "test3.th.com" ],
- "rule" : "webshell",
- "url_logic" : "equal",
- "url" : "/demo",
- "description" : ""
+ "domain" : [ "www.example.com" ],
+ "mode" : 1,
+ "description" : "",
+ "conditions" : [ {
+ "category" : "ip",
+ "logic_operation" : "equal",
+ "index" : null,
+ "contents" : [ "x.x.x.x" ]
+ } ],
+ "rule" : "091004"
}
Example ResponsesStatus code: 200
Request succeeded.
{
- "id" : "c20f67b3e1c040c0b0d8866e568ee8bf",
- "policyid" : "a75e96d8284c4c4f98ada7d391e8342c",
- "timestamp" : 1656507126528,
- "description" : "",
+ "id" : "40484384970948d79fffe4e4ae1fc54d",
+ "policyid" : "f385eceedf7c4c34a4d1def19eafbe85",
+ "timestamp" : 1650512535222,
+ "description" : "demo",
"status" : 1,
- "rule" : "webshell",
- "url_logic" : "equal",
- "url" : "/demo",
- "domain" : [ "test3.th.com" ]
+ "rule" : "091004",
+ "mode" : 1,
+ "conditions" : [ {
+ "category" : "ip",
+ "contents" : [ "x.x.x.x" ],
+ "logic_operation" : "equal"
+ } ],
+ "domain" : [ "www.example.com" ]
}
Status Codes
diff --git a/docs/wafd/api-ref/CreateInstance.html b/docs/wafd/api-ref/CreateInstance.html
index 16a1f25e..4e697a07 100644
--- a/docs/wafd/api-ref/CreateInstance.html
+++ b/docs/wafd/api-ref/CreateInstance.html
@@ -3,7 +3,7 @@
Creating a Dedicated WAF Engine
FunctionThis API is used to create a dedicated WAF engine
- URIPOST /v1/{project_id}/premium-waf/instance
+ URIPOST /v1/{project_id}/premium-waf/instance
Table 1 Path ParametersParameter
|
@@ -41,7 +41,7 @@
|---|
X-Auth-Token
|
-No
+ | Yes
|
String
|
@@ -72,16 +72,7 @@
-chargemode
- |
-No
- |
-Integer
- |
-Billing mode. Currently, only pay-per-use billing (30) is supported. Make sure your account balance is enough, or the dedicated WAF engine will forward requests directly to the origin server without inspection.
- |
-
-region
+ | region
|
Yes
|
@@ -105,7 +96,7 @@
String
|
-Dedicated engine CPU architecture. Its value can be x86 .
+ | Dedicated engine CPU architecture. Its value has to be x86.
|
instancename
@@ -123,7 +114,14 @@
|
String
|
-Specifications of the dedicated engine version. The value can be waf.instance.enterprise or waf.instance.professional. An enterprise edition dedicated engine has more functions than a professional edition one. For more details, see the Web Application Firewall (WAF) User Guide.
+ | Specifications of the dedicated engine version. The value can be waf.instance.enterprise or waf.instance.professional.
+waf.instance.professional: WI-100. Performance: 100 Mbit/s of throughput and 2,000 QPS.
+waf.instance.enterprise: WI-100. Performance: 500 Mbit/s of throughput and 10,000 QPS.
+
+Enumeration values:
+
|
cpu_flavor
@@ -132,7 +130,7 @@
|
String
|
-ID of the specifications of the ECS hosting the dedicated engine. It can be obtained by calling the ECS ListFlavors API. For the enterprise edition, ECS specifications with 8 vCPUs and 16 GB memory are used. For the professional edition, ECS specifications with 2 vCPUs and 4 GB memory are used.
+ | ID of the specifications of the ECS hosting the dedicated engine. You can go to the management console and confirm supported specifications.
|
vpc_id
@@ -171,6 +169,20 @@
| Number of dedicated engines to be provisioned
|
+res_tenant
+ |
+Yes
+ |
+Boolean
+ |
+Whether to create a dedicated engine instance of the network interface type. Its value has to be true.
+
+Enumeration values:
+
+ |
+
@@ -306,7 +318,6 @@
Example RequestsPOST https://{endpoint}/v1/{project_id}/premium-waf/instance
{
- "chargemode" : 30,
"region" : "region-01-4",
"available_zone" : "region-01-4a",
"arch" : "x86",
@@ -316,7 +327,8 @@
"vpc_id" : "d7b6a5ff-6c53-4cd4-9d57-f20ee8753056",
"subnet_id" : "e59ccd18-7e15-4588-b689-04b856f4e78b",
"security_group" : [ "09b156a2-f0f0-41fd-9891-60e594601cfd" ],
- "count" : 1
+ "count" : 1,
+ "res_tenant" : true
}
Example ResponsesStatus code: 200
diff --git a/docs/wafd/api-ref/CreatePolicy.html b/docs/wafd/api-ref/CreatePolicy.html
index cd06e915..8e6e8c9b 100644
--- a/docs/wafd/api-ref/CreatePolicy.html
+++ b/docs/wafd/api-ref/CreatePolicy.html
@@ -3,7 +3,7 @@
Creating a Policy
FunctionThis API is used to create a policy
- URIPOST /v1/{project_id}/waf/policy
+ URIPOST /v1/{project_id}/waf/policy
Table 1 Path ParametersParameter
|
@@ -151,13 +151,34 @@
Array of protected domain names for which the policy is used. Each policy can be used to one or more domain names. You can specify a policy for a domain name when you add the domain name to WAF by calling the API Adding a Protected Domain Name.
|
|---|
-host
+ | hosts
|
Array of strings
|
Array of IDs of protected domain names. The ID of a protected domain name is unique and generated by WAF when you add the domain name to WAF. To obtain the IDs, call the API Querying Domain Names Protected by Dedicated WAF Engines. To add a domain name to WAF, call the API Adding a Protected Domain Name.
|
+extend
+ |
+PolicyExtend object
+ |
+Switch for enabling or disabling Deep Inspection and Header Inspection in Basic Web Protection.
+ |
+
+share_info
+ |
+ShareInfo object
+ |
+Whether to share a policy. This parameter is reserved and can be ignored currently.
+ |
+
+modulex_options
+ |
+ModulexOptions object
+ |
+Whether to enable intelligent CC protection. This parameter is reserved and can be ignored currently.
+ |
+
timestamp
|
Long
@@ -165,13 +186,6 @@
| Time the policy is created. The value is a 13-digit timestamp, in ms.
|
-extend
- |
-Map<String,String>
- |
-This parameter is redundant in this version. It will be used in the later versions.
- |
-
@@ -234,19 +248,9 @@
Boolean
|
- Whether anti-crawler protection is enabled. Anti-crawler protection includes many specific anti-crawler checks, such as crawler_engine, crawler_scanner, crawler_script, and crawler_other. To enable any of these checks, keep anti-crawler protection enabled. The value can be:
-true: enabled
-false: disabled
-
- |
-
- crawler
- |
-Boolean
- |
-Whether feature-based anti-crawler is enabled. This parameter is fixed at true.
- |
@@ -294,7 +298,7 @@
Boolean
|
- Whether other crawler check is enabled. The value can be:
+ | Whether webshell check is enabled. The value can be:
true: enabled
false: disabled
@@ -380,25 +384,49 @@
|
+ followed_action
+ |
+Boolean
+ |
+Whether the Known Attack Source protection is enabled.. The value can be:
+true: enabled
+false: disabled
+
+ |
+
bot_enable
|
Boolean
|
-This parameter is redundant in this version. It will be used in the later versions.
+ | Feature-based anti-crawler. This feature includes many specific anti-crawler checks, such as crawler_engine, crawler_scanner, crawler_script, and crawler_other. To enable any of these checks, keep anti-crawler protection enabled. The value can be:
+true: Enabled
+false: Disabled
+
+ |
+
+ crawler
+ |
+Boolean
+ |
+This parameter is reserved and can be ignored currently.
|
precise
|
Boolean
|
-This parameter is redundant in this version. It will be used in the later versions.
+ | This parameter is reserved and can be ignored currently.
|
- followed_action
+ | modulex_enabled
|
Boolean
|
-This parameter is redundant in this version. It will be used in the later versions.
+ | This parameter is reserved and can be ignored currently.
+Enumeration values:
+
|
@@ -437,9 +465,31 @@
Status code: 400
-Table 8 Response body parametersParameter
+Table 8 PolicyExtendParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+extend
+ |
+String
+ |
+Protection statuses for advanced settings in basic web protection. By default, this parameter is left blank, and the Deep Inspection and Header Inspection are disabled.
+If deep_decode is set to true, the Deep Inspection is enabled.
+If check_all_headers is set to true, the Header Inspection is enabled.
+If deep_decode and check_all_headers are set to false, the Deep Inspection and Header Inspection are disabled.
+
+ |
+
+
+
+ Table 9 ShareInfoParameter
|
Type
|
@@ -447,18 +497,202 @@
|---|
-error_code
+ | share_count
|
-String
+ | Integer
|
-Error code
+ | Total number of the users who share the address group.
|
-error_msg
+ | accept_count
|
-String
+ | Integer
|
-Error message
+ | Number of users who accept the sharing
+ |
+
+process_status
+ |
+Integer
+ |
+Status
+ |
+
+
+
+ Table 10 ModulexOptionsParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+global_rate_enabled
+ |
+Boolean
+ |
+Status of the global rate limiting function (counting requests to all WAF instances when limiting traffic).
+false: Disabled.
+true: Enabled.
+
+ |
+
+global_rate_mode
+ |
+String
+ |
+Protection mode of the global rate limiting function.
+
+Enumeration values:
+
+ |
+
+precise_rules_enabled
+ |
+Boolean
+ |
+Status of the intelligent precise protection.
+false: Disabled.
+true: Enabled.
+
+ |
+
+precise_rules_mode
+ |
+String
+ |
+Protection mode of the intelligent precise protection.
+
+Enumeration values:
+
+ |
+
+precise_rules_managed_mode
+ |
+String
+ |
+Management mode of the intelligent precise protection.
+
+Enumeration values:
+
+ |
+
+precise_rules_aging_mode
+ |
+String
+ |
+Aging mode of the intelligent precise protection.
+
+Enumeration values:
+
+ |
+
+precise_rules_retention
+ |
+Integer
+ |
+Maximum age of the intelligent precise protection.
+ |
+
+cc_rules_enabled
+ |
+Boolean
+ |
+Status of the intelligent CC attack protection.
+false: Disabled.
+true: Enabled.
+
+ |
+
+cc_rules_mode
+ |
+String
+ |
+Protection mode of the intelligent CC attack protection rule.
+
+Enumeration values:
+
+ |
+
+cc_rules_managed_mode
+ |
+String
+ |
+Management mode of the intelligent CC attack protection.
+
+Enumeration values:
+
+ |
+
+cc_rules_aging_mode
+ |
+String
+ |
+Aging mode of the intelligent CC attack protection..
+
+Enumeration values:
+
+ |
+
+cc_rules_retention
+ |
+Integer
+ |
+Maximum age of the intelligent CC attack protection.
+ |
+
+
+
+ Status code: 400
+
+Table 11 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code
+ |
+
+error_msg
+ |
+String
+ |
+Error message
|
@@ -466,26 +700,26 @@
Status code: 401
-Table 9 Response body parametersParameter
+Table 12 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -493,26 +727,26 @@
Status code: 403
-Table 10 Response body parametersParameter
+Table 13 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -520,26 +754,26 @@
Status code: 500
-Table 11 Response body parametersParameter
+Table 14 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
diff --git a/docs/wafd/api-ref/CreatePremiumHost.html b/docs/wafd/api-ref/CreatePremiumHost.html
index db85c30b..c25d2a82 100644
--- a/docs/wafd/api-ref/CreatePremiumHost.html
+++ b/docs/wafd/api-ref/CreatePremiumHost.html
@@ -1,9 +1,9 @@
Adding a Protected Domain Name
-FunctionAdding a Protected Domain Name
+ FunctionThis API is used to add a domain name to WAF.
- URIPOST /v1/{project_id}/premium-waf/host
+ URIPOST /v1/{project_id}/premium-waf/host
Table 1 Path ParametersParameter
|
@@ -78,7 +78,7 @@
String
|
-HTTPS certificate ID. It can be obtained by calling the ListCertificates API.This parameter is not required when the client protocol is HTTP, but it is mandatory when the client protocol is HTTPS.
+ | HTTPS certificate ID. It can be obtained by calling the ListCertificates API. This parameter is not required when the client protocol is HTTP, but it is mandatory when the client protocol is HTTPS.
|
|---|
certificatename
@@ -87,7 +87,7 @@
|
String
|
-Certificate name. Certifacteid and certificatename are required at the same. If certificateid does not match certificatename, an error is reported.This parameter is not required when the client protocol is HTTP, but it is mandatory when the client protocol is HTTPS.
+ | Certificate name. Certifacteid and certificatename are required at the same. If certificateid does not match certificatename, an error is reported. This parameter is not required when the client protocol is HTTP, but it is mandatory when the client protocol is HTTPS.
|
hostname
@@ -114,7 +114,7 @@
|
String
|
-ID of the policy initially used to the domain name. It can be obtained by calling the API described in 2.1.1 Querying Protection Policies.
+ | ID of the policy initially used to the domain name. It can be obtained by calling the API Querying Protection Policies.
|
server
@@ -126,6 +126,24 @@
| Server configuration in dedicated mode
|
+web_tag
+ |
+No
+ |
+String
+ |
+website name
+ |
+
+description
+ |
+No
+ |
+String
+ |
+website remarks
+ |
+
@@ -209,6 +227,15 @@
+ weight
+ |
+No
+ |
+Integer
+ |
+This parameter is reserved and can be ignored currently.
+ |
+
| String
|
-HTTP protocol
+ | Client protocol, which is the protocol used by a client (for example, a browser) to access your website.
+Enumeration values:
+
|
|---|
protect_status
@@ -306,7 +337,7 @@
|
Flag object
|
-Special domain name identifier, which is used to store additional domain name configuration.
+ | Feature switch for configuring compliance certification checks for domain names protected with the dedicated WAF instance.
|
block_page
@@ -318,9 +349,31 @@
|
extend
|
-Map<String,String>
+ | Extend object
|
-This parameter is redundant in this version. It will be used in the later versions.
+ | This parameter includes some extended information about the protected domain name.
+ |
+
+web_tag
+ |
+String
+ |
+website name
+ |
+
+description
+ |
+String
+ |
+website remarks
+ |
+
+locked
+ |
+Integer
+ |
+This parameter is reserved, which will be used to freeze a domain name.
+Default: 0
|
timestamp
@@ -399,6 +452,13 @@
|
+weight
+ |
+Integer
+ |
+This parameter is reserved and can be ignored currently.
+ |
+
String
|
-Whether PCI 3DS certification check is enabled for the domain name. Currently, this function is not supported. The default value is false. You can ignore this parameter.
-true: PCI 3DS check is enabled.
-false: PCI 3DS check is disenabled.
+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.
+
+Enumeration values:
+
|
@@ -425,9 +489,13 @@
|
String
|
-Whether PCI DDS certification check is enabled for the domain name.
-true: PCI DDS check is enabled.
-false: PCI DDS check is disenabled.
+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.
+
+Enumeration values:
+
|
@@ -447,7 +515,11 @@
|
String
|
-Template name
+ | 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.
+
|
custom_page
@@ -500,28 +572,54 @@
|
Status code: 400
-Table 10 Response body parametersParameter
+Table 10 ExtendParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | ltsInfo
|
-String
+ | String
|
-Error code
+ | Details about LTS configuration
|
-error_msg
+ | extend
|
-String
+ | String
|
-Error message
+ | Timeout configuration details.
+ |
+
+
+
+ Status code: 400
+
+Table 11 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code
+ |
+
+error_msg
+ |
+String
+ |
+Error message
|
@@ -529,26 +627,26 @@
Status code: 401
-Table 11 Response body parametersParameter
+Table 12 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -556,26 +654,26 @@
Status code: 500
-Table 12 Response body parametersParameter
+Table 13 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
diff --git a/docs/wafd/api-ref/CreatePrivacyRules.html b/docs/wafd/api-ref/CreatePrivacyRules.html
index 9a1ee04e..6517bda0 100644
--- a/docs/wafd/api-ref/CreatePrivacyRules.html
+++ b/docs/wafd/api-ref/CreatePrivacyRules.html
@@ -1,9 +1,9 @@
Creating a Data Masking Rule
-FunctionCreating a Data Masking Rule
+ FunctionThis API is used to create a data masking rule.
- URIPOST /v1/{project_id}/waf/policy/{policy_id}/privacy
+ URIPOST /v1/{project_id}/waf/policy/{policy_id}/privacy
Table 1 Path ParametersParameter
|
@@ -30,7 +30,7 @@
String
|
-Policy ID
+ | Policy ID. It can be obtained by calling the ListPolicy API.
|
|---|
diff --git a/docs/wafd/api-ref/CreatePunishmentRules.html b/docs/wafd/api-ref/CreatePunishmentRules.html
new file mode 100644
index 00000000..4cb7a665
--- /dev/null
+++ b/docs/wafd/api-ref/CreatePunishmentRules.html
@@ -0,0 +1,318 @@
+
+
+Creating a Known Attack Source Rule
+FunctionThis API is used to create a known attack source rule.
+
+ URIPOST /v1/{project_id}/waf/policy/{policy_id}/punishment
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+project_id
+ |
+
+policy_id
+ |
+Yes
+ |
+String
+ |
+Policy ID. It can be obtained by calling the ListPolicy API.
+ |
+
+
+
+
+
+ Request Parameters
+
+
+
+ Table 3 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+category
+ |
+Yes
+ |
+String
+ |
+Type of the know attack source rule.
+Enumeration values:
+long_ip_block
+long_cookie_block
+long_params_block
+short_ip_block
+short_cookie_block
+short_params_block
+
+ |
+
+block_time
+ |
+Yes
+ |
+Integer
+ |
+Block duration, in seconds. If prefix long is selected for the rule type, the value for block_time ranges from 301 to 1800. If prefix short is selected for the rule type, the value for block_time ranges from 0 to 300.
+ |
+
+description
+ |
+No
+ |
+String
+ |
+Description
+ |
+
+
+
+
+
+ Response ParametersStatus code: 200
+
+ Table 4 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Rule ID
+ |
+
+policyid
+ |
+String
+ |
+Policy ID
+ |
+
+block_time
+ |
+Integer
+ |
+Block duration, in seconds.
+ |
+
+category
+ |
+String
+ |
+Type of the know attack source rule.
+ |
+
+description
+ |
+String
+ |
+Description
+ |
+
+timestamp
+ |
+Long
+ |
+Timestamp the rule is created.
+ |
+
+
+
+
+ Status code: 400
+
+ Table 5 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code
+ |
+
+error_msg
+ |
+String
+ |
+Error message
+ |
+
+
+
+
+ Status code: 401
+
+ Table 6 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code
+ |
+
+error_msg
+ |
+String
+ |
+Error message
+ |
+
+
+
+
+ Status code: 500
+
+ Table 7 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code
+ |
+
+error_msg
+ |
+String
+ |
+Error message
+ |
+
+
+
+
+
+ Example RequestsPOST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/punishment?
+
+{
+ "category" : "long_ip_block",
+ "block_time" : "1233",
+ "description" : "demo"
+}
+
+ Example ResponsesStatus code: 200
+ Request succeeded.
+ {
+ "block_time" : 1233,
+ "category" : "long_ip_block",
+ "description" : "demo",
+ "id" : "2c3afdcc982b429da4f72ee483aece3e",
+ "policyid" : "2fcbcb23ef0d48d99d24d7dcff00307d",
+ "timestamp" : 1668148186106
+}
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+Request succeeded.
+ |
+
+400
+ |
+Request failed.
+ |
+
+401
+ |
+The token does not have required permissions.
+ |
+
+500
+ |
+Internal server error.
+ |
+
+
+
+
+
+
+ Adding a Reference Table
+Creating a Reference Table
FunctionThis API is used to create a reference table. A reference table can be referenced by CC attack protection rules and precise protection rules. For details about how to use reference tables, see "Adding a Reference Table" under "Rule Configurations" in Web Application Firewall User Guide.
- URIPOST /v1/{project_id}/waf/valuelist
+ URIPOST /v1/{project_id}/waf/valuelist
Table 1 Path ParametersParameter
|
@@ -87,7 +87,7 @@
String
|
-Reference table type. For details, see the enumeration list
+ | Reference table type. For details, see the enumeration values as followed.
Enumeration values:
url
params
@@ -98,7 +98,7 @@
header
response_code
response_header
-resopnse_body
+response_body
|
|---|
@@ -171,6 +171,23 @@
Value of the reference table
|
+description
+ |
+String
+ |
+Reference table description
+ |
+
+producer
+ |
+Integer
+ |
+This parameter is reserved and can be ignored currently.
+Enumeration values:
+
+ |
+
diff --git a/docs/wafd/api-ref/CreateWhiteblackipRule.html b/docs/wafd/api-ref/CreateWhiteblackipRule.html
index 414858b1..415f09aa 100644
--- a/docs/wafd/api-ref/CreateWhiteblackipRule.html
+++ b/docs/wafd/api-ref/CreateWhiteblackipRule.html
@@ -1,9 +1,9 @@
Creating a Blacklist or Whitelist Rule
- Functionhis API is used to create a blacklist or whitelist rule.
+ FunctionThis API is used to create a blacklist or whitelist rule.
- URIPOST /v1/{project_id}/waf/policy/{policy_id}/whiteblackip
+ URIPOST /v1/{project_id}/waf/policy/{policy_id}/whiteblackip
Table 1 Path ParametersParameter
|
@@ -30,7 +30,7 @@
String
|
-Policy ID
+ | Policy ID. It can be obtained by calling the ListPolicy API.
|
|---|
@@ -63,7 +63,7 @@
String
|
-Conten type.
+ | Content type.
Default: application/json;charset=utf8
|
@@ -81,7 +81,16 @@
-description
+ | name
+ |
+No
+ |
+String
+ |
+Rule name.
+ |
+
+description
|
No
|
@@ -96,7 +105,7 @@
String
|
-lacklisted or whitelisted IP addresses
+ | IP addresses or an IP address range. -IP addresses: IP addresses to be added to the blacklist or whitelist, for example, 192.x.x.3 -IP address range: IP address and subnet mask, for example, 10.x.x.0/24
|
white
@@ -112,6 +121,15 @@
|
+followed_action_id
+ |
+No
+ |
+String
+ |
+ID of a known attack source rule. This parameter can be configured only when white is set to 0.
+ |
+
@@ -133,6 +151,13 @@
Rule ID
|
+ name
+ |
+String
+ |
+Rule name.
+ |
+
policyid
|
String
@@ -168,7 +193,7 @@
|
String
|
-lacklisted or whitelisted IP addresses
+ | Blacklisted or whitelisted IP addresses
|
white
@@ -182,6 +207,13 @@
|
+ followed_action_id
+ |
+String
+ |
+ID of the known attack source rule.
+ |
+
@@ -284,8 +316,7 @@
"description" : "demo",
"status" : 1,
"addr" : "x.x.x.x",
- "white" : 0,
- "size" : 1
+ "white" : 0
}
Status Codes
diff --git a/docs/wafd/api-ref/DeleteAnticrawlerRule.html b/docs/wafd/api-ref/DeleteAnticrawlerRule.html
new file mode 100644
index 00000000..b1d2105a
--- /dev/null
+++ b/docs/wafd/api-ref/DeleteAnticrawlerRule.html
@@ -0,0 +1,326 @@
+
+
+ Deleting a JavaScript Anti-Crawler Rule
+ FunctionThis API is used to delete a JavaScript anti-crawler rule.
+
+ URIDELETE /v1/{project_id}/waf/policy/{policy_id}/anticrawler/{rule_id}
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials. Then, in the Projects area, view Project ID of the corresponding project.
+ |
+
+policy_id
+ |
+Yes
+ |
+String
+ |
+ID of a protection policy. You can specify a protection policy ID to query the rules used in the protection policy. You can obtain the policy ID by calling the ListPolicy API.
+ |
+
+rule_id
+ |
+Yes
+ |
+String
+ |
+Rule ID.
+ |
+
+
+
+
+
+ Table 2 Query ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+enterprise_project_id
+ |
+No
+ |
+String
+ |
+You can obtain the ID by calling the ListEnterpriseProject API of EPS.
+ |
+
+
+
+
+
+
+ Response ParametersStatus code: 200
+
+ Table 4 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+policyid
+ |
+String
+ |
+Policy ID.
+ |
+
+id
+ |
+String
+ |
+Rule ID.
+ |
+
+url
+ |
+String
+ |
+URL to which the rule applies.
+ |
+
+logic
+ |
+Integer
+ |
+Rule matching logic
+1: Include
+2: Not include
+3: Equal
+4: Not equal
+5: Prefix is
+6: Prefix is not
+7: Suffix is
+8: Suffix is not
+
+ |
+
+name
+ |
+String
+ |
+Rule name.
+ |
+
+type
+ |
+String
+ |
+JavaScript anti-crawler rule type.
+
+ |
+
+timestamp
+ |
+Long
+ |
+Timestamp the rule is created.
+ |
+
+status
+ |
+Integer
+ |
+Rule status. The value can be 0 or 1.
+0: The rule is disabled.
+1: The rule is enabled.
+
+ |
+
+
+
+
+ Status code: 400
+
+ Table 5 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code
+ |
+
+error_msg
+ |
+String
+ |
+Error message
+ |
+
+
+
+
+ Status code: 401
+
+ Table 6 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code
+ |
+
+error_msg
+ |
+String
+ |
+Error message
+ |
+
+
+
+
+ Status code: 500
+
+ Table 7 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code
+ |
+
+error_msg
+ |
+String
+ |
+Error message
+ |
+
+
+
+
+
+ Example RequestsDELETE https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/anticrawler/{rule_id}?
+
+ Example ResponsesStatus code: 200
+ ok
+ {
+ "id" : "607d14b8153540c0af51a00fe2140d05",
+ "policyid" : "777716e0b7b84b5192b9d373f7c6d4f0",
+ "name" : "demo",
+ "timestamp" : 1675152776784,
+ "status" : 1,
+ "url" : "/patent/id",
+ "logic" : 3,
+ "type" : "anticrawler_except_url"
+}
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+ok
+ |
+
+400
+ |
+Request failed.
+ |
+
+401
+ |
+The token does not have required permissions.
+ |
+
+500
+ |
+Internal server error.
+ |
+
+
+
+
+
+
+
+
+
diff --git a/docs/wafd/api-ref/DeleteAntileakageRule.html b/docs/wafd/api-ref/DeleteAntileakageRule.html
new file mode 100644
index 00000000..32017495
--- /dev/null
+++ b/docs/wafd/api-ref/DeleteAntileakageRule.html
@@ -0,0 +1,298 @@
+
+
+ Deleting an Information Leakage Prevention Rule
+ FunctionThis API is used to delete an information leakage prevention rule.
+
+ URIDELETE /v1/{project_id}/waf/policy/{policy_id}/antileakage/{rule_id}
+
+ Table 1 Path ParametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+project ID
+ |
+
+policy_id
+ |
+Yes
+ |
+String
+ |
+Policy ID. It can be obtained by calling the ListPolicy API.
+ |
+
+rule_id
+ |
+Yes
+ |
+String
+ |
+ID of the information leakage protection rule. It can be obtained by calling the ListAntileakageRules API.
+ |
+
+
+
+
+
+
+ Response ParametersStatus code: 200
+
+ Table 3 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Rule ID
+ |
+
+url
+ |
+String
+ |
+URL to which the rule applies.
+ |
+
+category
+ |
+String
+ |
+Sensitive information type in the information leakage prevention rule.
+sensitive: The rule masks sensitive user information, such as ID code, phone numbers, and email addresses.
+code: The rule blocks response pages of specified HTTP response code.
+
+Enumeration values:
+
+ |
+
+contents
+ |
+Array of strings
+ |
+Content corresponding to the sensitive information type. Multiple options can be set.
+When category is set to code, the pages that contain the following HTTP response codes will be blocked: 400, 401, 402, 403, 404, 405, 500, 501, 502, 503, 504 and 507.
+When category is set to sensitive, parameters phone, id_card, and email can be set.
+
+ |
+
+timestamp
+ |
+Long
+ |
+Timestamp the rule is created.
+ |
+
+description
+ |
+String
+ |
+Rule description.
+ |
+
+status
+ |
+Integer
+ |
+Rule status. The value can be:
+0: The rule is disabled.
+1: The rule is enabled.
+
+Enumeration values:
+
+ |
+
+
+
+
+ Status code: 400
+
+ Table 4 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code
+ |
+
+error_msg
+ |
+String
+ |
+Error message
+ |
+
+
+
+
+ Status code: 401
+
+ Table 5 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code
+ |
+
+error_msg
+ |
+String
+ |
+Error message
+ |
+
+
+
+
+ Status code: 500
+
+ Table 6 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code
+ |
+
+error_msg
+ |
+String
+ |
+Error message
+ |
+
+
+
+
+
+ Example RequestsDELETE https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/antileakage/{rule_id}?
+
+ Example ResponsesStatus code: 200
+ Request succeeded.
+ {
+ "id" : "82c4f04f84fd4b2b9ba4b4ea0df8ee82",
+ "policyid" : "2fcbcb23ef0d48d99d24d7dcff00307d",
+ "timestamp" : 1668152426471,
+ "description" : "demo",
+ "status" : 1,
+ "url" : "/attack",
+ "category" : "sensitive",
+ "contents" : [ "id_card" ]
+}
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+Request succeeded.
+ |
+
+400
+ |
+Request failed.
+ |
+
+401
+ |
+The token does not have required permissions.
+ |
+
+500
+ |
+Internal server error.
+ |
+
+
+
+
+
+
+
+
+
diff --git a/docs/wafd/api-ref/DeleteAntitamperRule.html b/docs/wafd/api-ref/DeleteAntitamperRule.html
index 3ba95933..69d05df6 100644
--- a/docs/wafd/api-ref/DeleteAntitamperRule.html
+++ b/docs/wafd/api-ref/DeleteAntitamperRule.html
@@ -3,7 +3,7 @@
Deleting a Web Tamper Protection Rule
FunctionThis API is used to delete a web tamper protection rule.
- URIDELETE /v1/{project_id}/waf/policy/{policy_id}/antitamper/{rule_id}
+ URIDELETE /v1/{project_id}/waf/policy/{policy_id}/antitamper/{rule_id}
Table 1 Path ParametersParameter
|
@@ -30,7 +30,7 @@
String
|
-Policy ID
+ | Policy ID. It can be obtained by calling the ListPolicy API.
|
|---|
rule_id
@@ -39,7 +39,7 @@
|
String
|
-Rule ID
+ | ID of the web tamper protection rule. It can be obtained by calling the ListAntitamperRules API.
|
@@ -132,7 +132,7 @@
String
|
-Domain name protected by the web tamper protection rule
+ | The domain name of the website protected with the web tamper protection rule. The domain name is in the format of xxx.xxx.com, such as www.example.com.
|
url
diff --git a/docs/wafd/api-ref/DeleteCcRule.html b/docs/wafd/api-ref/DeleteCcRule.html
index 45c5d7d5..cb5cb359 100644
--- a/docs/wafd/api-ref/DeleteCcRule.html
+++ b/docs/wafd/api-ref/DeleteCcRule.html
@@ -3,7 +3,7 @@
Deleting a CC Attack Protection Rule
FunctionThis API is used to delete a CC attack protection rule.
- URIDELETE /v1/{project_id}/waf/policy/{policy_id}/cc/{rule_id}
+ URIDELETE /v1/{project_id}/waf/policy/{policy_id}/cc/{rule_id}
Table 1 Path ParametersParameter
|
@@ -21,7 +21,7 @@
String
|
-Content type.
+ | project ID
|
|---|
policy_id
@@ -30,7 +30,7 @@
|
String
|
-Policy ID. It can be obtained by calling the API Querying Protection Policies.
+ | Policy ID. It can be obtained by calling the ListPolicy API.
|
rule_id
@@ -39,7 +39,7 @@
|
String
|
-ccRuleId
+ | ID of the cc rule. It can be obtained by calling the ListCcRules API.
|
@@ -127,39 +127,7 @@
Mode.
0: Standard.
-1: Advanced
-
- |
-
-limit_num
- |
-String
- |
-Number of requests allowed from a web visitor in a rate limiting period
- |
-
-limit_period
- |
-String
- |
-Rate limiting period
- |
-
-lock_time
- |
-String
- |
-How long a web visitor will be locked The value range is [0 to 2^32), in seconds.
- |
-
-tag_type
- |
-String
- |
-Protection mode.
-ip: IP-based rate limiting. Website visitors are identified by IP address.
-cookie: User-based rate limiting. Website visitors are identified by the cookie key value.
-other: A website visitor is identified by the Referer field (user-defined request source).
+1: Advanced.
|
@@ -173,6 +141,82 @@
+conditions
+ |
+Array of CcCondition objects
+ |
+Rate limit conditions of the CC attack protection rule. This parameter is mandatory when the CC attack protection rule is in advanced mode (i.e. the value of mode is 1).
+ |
+
+action
+ |
+action object
+ |
+Protection action to take if the number of requests reaches the upper limit.
+ |
+
+tag_type
+ |
+String
+ |
+Rate limit mode.
+ip: IP-based rate limiting. Website visitors are identified by IP address.
+cookie: User-based rate limiting. Website visitors are identified by the cookie key value.
+other: Website visitors are identified by the Referer field (user-defined request source).
+
+Enumeration values:
+ip
+other
+cookie
+header
+
+ |
+
+tag_index
+ |
+String
+ |
+User identifier. This parameter is mandatory when the rate limit mode is set to user (cookie or header).
+cookie: Set the cookie field name. You need to configure an attribute variable name in the cookie that can uniquely identify a web visitor based on your website requirements. This field does not support regular expressions. Only complete matches are supported. For example, if a website uses the name field in the cookie to uniquely identify a website visitor, select name.
+header: Set the user-defined HTTP header you want to protect. You need to configure the HTTP header that can identify web visitors based on your website requirements.
+
+ |
+
+tag_condition
+ |
+tag_condition object
+ |
+User tag. This parameter is mandatory when the rate limit mode is set to other. - other: A website visitor is identified by the Referer field (user-defined request source).
+ |
+
+limit_num
+ |
+Integer
+ |
+Rate limit frequency based on the number of requests. The value ranges from 1 to 2,147,483,647.
+ |
+
+limit_period
+ |
+Integer
+ |
+Rate limit period, in seconds. The value ranges from 1 to 3,600.
+ |
+
+unlock_num
+ |
+Integer
+ |
+Allowable frequency based on the number of requests. The value ranges from 0 to 2,147,483,647. This parameter is required only when the protection action type is dynamic_block.
+ |
+
+lock_time
+ |
+Integer
+ |
+Block duration, in seconds. The value ranges from 0 to 65,535. Specifies the period within which access is blocked. An error page is displayed in this period.
+ |
+
description
|
String
@@ -180,18 +224,32 @@
| Rule description
|
-action
+ | total_num
|
-action object
+ | Integer
|
-Action to take if the number of requests reaches the upper limit.
+ | This parameter is reserved and can be ignored currently.
|
-conditions
+ | unaggregation
|
-Array of conditions objects
+ | Boolean
|
-Condition list. This parameter is returned when mode is set to 1.
+ | This parameter is reserved and can be ignored currently.
+ |
+
+aging_time
+ |
+Integer
+ |
+Rule aging time. This parameter is reserved and can be ignored currently.
+ |
+
+producer
+ |
+Integer
+ |
+Rule creation object. This parameter is reserved and can be ignored currently.
|
timestamp
@@ -205,7 +263,7 @@
|
- Table 4 actionParameter
+Table 4 CcConditionParameter
|
Type
|
@@ -217,28 +275,77 @@
String
|
-Action type:
-block: WAF blocks discovered attacks.
-captcha: Verification code. WAF requires visitors to enter a correct verification code to continue their access to requested page on your website.
-If tag_type is set to other, the value can only be block.
+Field type. The value can be url, ip, params, cookie, or header.
+Enumeration values:
+url
+ip
+params
+cookie
+header
|
|
|---|
-detail
+ | logic_operation
|
String
|
-Action details. If detail is null, the default block page is displayed by default.
-This parameter cannot be included when category is set to captcha.
-This parameter is required when category is set to block.
+Logic for matching the condition.
+If the category is url, the optional operations are contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, not_suffix, contain_any, not_contain_all, equal_any, not_equal_all, equal_any, not_equal_all, prefix_any, not_prefix_all, suffix_any, not_suffix_all, len_greater, len_less, len_equal and len_not_equal
+If the category is ip, the optional operations are: equal, not_equal, , equal_any and not_equal_all
+If the category is params, cookie and header, the optional operations are: contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, not_suffix, contain_any, not_contain_all, equal_any, not_equal_all, equal_any, not_equal_all, prefix_any, not_prefix_all, suffix_any, not_suffix_all, len_greater, len_less, len_equal, len_not_equal, num_greater, num_less, num_equal, num_not_equal, exist and not_exist
+Enumeration values:
+contain
+not_contain
+equal
+not_equal
+prefix
+not_prefix
+suffix
+not_suffix
+contain_any
+not_contain_all
+equal_any
+not_equal_all
+prefix_any
+not_prefix_all
+suffix_any
+not_suffix_all
+num_greater
+num_less
+num_equal
+num_not_equal
+exist
+not_exist
+
+ |
+
|
+contents
+ |
+Array of strings
+ |
+Content of the conditions. This parameter is mandatory when the suffix of logic_operation is not any or all.
+ |
+
+value_list_id
+ |
+String
+ |
+Reference table ID. It can be obtained by calling the API Querying the Reference Table List. This parameter is mandatory when the suffix of logic_operation is any or all. The reference table type must be the same as the category type.
+ |
+
+index
+ |
+String
+ |
+Subfield. When category is set to params, cookie, or header, set this parameter based on site requirements. This parameter is mandatory.
|
Table 5 detailParameter
+Table 5 actionParameter
|
Type
|
@@ -246,18 +353,39 @@
|---|
-response
+ | category
|
-response object
+ | String
|
-Returned page.
+ | Action type:
+captcha: Verification code. WAF requires visitors to enter a correct verification code to continue their access to requested page on your website.
+block: WAF blocks the requests. When tag_type is set to other, the value can only be block.
+log: WAF logs the event only.
+dynamic_block: In the previous rate limit period, if the request frequency exceeds the value of Rate Limit Frequency, the request is blocked. In the next rate limit period, if the request frequency exceeds the value of Permit Frequency, the request is still blocked. Note: The dynamic_block protection action can be set only when the advanced protection mode is enabled for the CC protection rule.
+
+Enumeration values:
+captcha
+block
+log
+dynamic_block
+
+ |
+
+detail
+ |
+detail object
+ |
+Block page information. When protection action category is set to block or dynamic_block, you need to set the returned block page.
+If you want to use the default block page, this parameter can be excluded.
+If you want to use a custom block page, set this parameter.
+
|
Table 6 responseParameter
+Table 6 detailParameter
|
Type
|
@@ -265,25 +393,18 @@
|---|
-content_type
+ | response
|
-String
+ | response object
|
-Content type. The value can only be application/json, text/html, or text/xml.
- |
-
-content
- |
-String
- |
-Contents
+ | Block Page
|
Table 7 conditionsParameter
+Table 7 responseParameter
|
Type
|
@@ -291,39 +412,49 @@
|---|
-category
+ | content_type
|
String
|
-Field type. The options are as follows: ip, cookie, and url
- |
-
-index
- |
-String
- |
-Parameter description:
-When the field type is ip or url, the index parameter is not required.
-When the field type is cookie and the subfield is customized, the value of index is the customized subfield.
+Content type. The value can only be application/json, text/html, or text/xml.
+Enumeration values:
+application/json
+text/html
+text/xml
|
|
-logic_operation
+ | content
|
String
|
-Condition matching logic. The options are contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, not_suffix, equal_any, and not_equal_any, contain_any, and not_contain_any.
-When the field type is url, the following matching logics are supported: contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, and not_suffix.
-When the field type is ip, the following matching logics are supported: equal, not_equal, equal_any, and not_equal_any.
-When category is set to cookie, the following matching logics are supported: contain, not_contain, equal, not_equal. prefix, not_prefix, suffix, not_suffix, contain_any, and not_contain_any.
-
+ | Block page information.
|
-contents
+ |
+
+ Table 8 tag_conditionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+category
|
-Array of strings
+ | String
|
-Content of the conditions.
+ | User identifier. The value is fixed at referer.
+ |
+
+contents
+ |
+Array of strings
+ |
+Content of the user identifier field.
|
@@ -331,26 +462,26 @@
Status code: 400
-Table 8 Response body parametersParameter
+Table 9 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -358,26 +489,26 @@
Status code: 401
-Table 9 Response body parametersParameter
+Table 10 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -385,26 +516,26 @@
Status code: 500
-Table 10 Response body parametersParameter
+Table 11 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code
+ | Error code
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error message
+ | Error message
|
@@ -416,7 +547,6 @@
Example ResponsesStatus code: 200
Request succeeded.
{
- "aging_time" : 0,
"description" : "",
"id" : "a5f3fd28db564696b199228f0ac346b2",
"limit_num" : 10,
@@ -425,12 +555,13 @@
"mode" : 0,
"policyid" : "1f016cde588646aca3fb19f277c44d03",
"prefix" : false,
- "producer" : 1,
"status" : 1,
"tag_type" : "ip",
"timestamp" : 1656494435686,
"total_num" : 0,
+ "aging_time" : 0,
"unaggregation" : false,
+ "producer" : 1,
"url" : "/path1"
}
Deleting a Certificate
FunctionThis API is used to delete a certificate.
- URIDELETE /v1/{project_id}/waf/certificate/{certificate_id}
+ URIDELETE /v1/{project_id}/waf/certificate/{certificate_id}
Table 1 Path ParametersParameter
|
diff --git a/docs/wafd/api-ref/DeleteCustomRule.html b/docs/wafd/api-ref/DeleteCustomRule.html
index fa0895a3..e3c3fadf 100644
--- a/docs/wafd/api-ref/DeleteCustomRule.html
+++ b/docs/wafd/api-ref/DeleteCustomRule.html
@@ -3,7 +3,7 @@
Deleting a Precise Protection Rule
FunctionThis API is used to delete a precise protection rule.
- URIDELETE /v1/{project_id}/waf/policy/{policy_id}/custom/{rule_id}
+ URIDELETE /v1/{project_id}/waf/policy/{policy_id}/custom/{rule_id}
Table 1 Path ParametersParameter
|
@@ -30,7 +30,7 @@
String
|
-Policy ID.
+ | Policy ID. It can be obtained by calling the ListPolicy API.
|
|---|
rule_id
@@ -39,7 +39,7 @@
|
String
|
-customRuleId
+ | ID of the precise protection rule. It can be obtained by calling the ListCustomeRules API.
|
@@ -68,7 +68,7 @@
Content-Type
|
-Yes
+ | No
|
String
|
@@ -135,13 +135,6 @@
Protective action of the precise protection rule.
|
-action_mode
- |
-Boolean
- |
-This parameter is reserved and can be ignored.
- |
-
priority
|
Integer
@@ -170,6 +163,27 @@
| Timestamp (ms) when the precise protection rule expires. This parameter is returned only when time is true.
|
+action_mode
+ |
+Boolean
+ |
+This parameter is reserved and can be ignored currently.
+ |
+
+aging_time
+ |
+Integer
+ |
+Rule aging time. This parameter is reserved and can be ignored currently.
+ |
+
+producer
+ |
+Integer
+ |
+Rule creation object. This parameter is reserved and can be ignored currently.
+ |
+
@@ -195,7 +209,7 @@
Subfield
When the field type is url, user-agent, ip, refer, request_line, method, or request, index is not required.
-If the field type is params, header, or cookie, and the subfield is customized, the value of index is the customized subfield.
+When the field type is params, header, or cookie, and the subfield is customized, the value of index is the customized subfield.
|
|---|
@@ -203,7 +217,35 @@
String
|
-Logic for matching the condition. The options are contain, not_contain, equal, not_equal, prefix, not_prefix, suffix, and not_suffix. For more details, see the console UI.
+ | Logic for matching the condition.
+Enumeration values:
+contain
+not_contain
+equal
+not_equal
+prefix
+not_prefix
+suffix
+not_suffix
+contain_any
+not_contain_all
+equal_any
+not_equal_all
+prefix_any
+not_prefix_all
+suffix_any
+not_suffix_all
+len_greater
+len_less
+len_equal
+len_not_equal
+num_greater
+num_less
+num_equal
+num_not_equal
+exist
+not_exist
+
|
contents
@@ -213,6 +255,13 @@
| Content of the conditions.
|
+value_list_id
+ |
+String
+ |
+Reference table ID. It can be obtained by calling the API Querying the Reference Table List. This parameter is available only when a reference table is used when a protection rule is created.
+ |
+
@@ -229,10 +278,23 @@
String
|
- Action type.
-block: WAF blocks attacks.
-pass: WAF allows requests.
+Operation type
+block: WAF blocks attacks.
+pass: WAF allows requests.
+log: WAF only logs detected attacks.
+Enumeration values:
+
+ |
+
+followed_action_id
+ |
+String
+ |
+ID of a known attack source rule. This parameter can be configured only when category is set to block.
|
@@ -325,24 +387,24 @@
Example ResponsesStatus code: 200
Request succeeded.
{
+ "id" : "88e8bf4158324b2d9a233e7ffb95516d",
+ "policyid" : "dde63c25e8394b21b16a2a49a99e659b",
+ "timestamp" : 1678799936830,
+ "description" : "",
+ "status" : 1,
+ "time" : false,
+ "priority" : 50,
+ "action_mode" : false,
+ "conditions" : [ {
+ "category" : "url",
+ "contents" : [ "test" ],
+ "logic_operation" : "contain"
+ } ],
"action" : {
"category" : "block"
},
- "action_mode" : false,
- "aging_time" : 0,
- "conditions" : [ {
- "category" : "header",
- "index" : "demo",
- "logic_operation" : "contain",
- "content" : [ "demo" ]
- } ],
- "description" : "",
- "id" : "2a3caa2bc9814c09ad73d02e3485b4a4",
- "policyid" : "1f016cde588646aca3fb19f277c44d03",
- "priority" : 50,
- "status" : 1,
- "time" : false,
- "timestamp" : 1656495488880
+ "producer" : 1,
+ "aging_time" : 0
}
Status Codes
diff --git a/docs/wafd/api-ref/DeleteGeoipRule.html b/docs/wafd/api-ref/DeleteGeoipRule.html
index f11fa40d..11037885 100644
--- a/docs/wafd/api-ref/DeleteGeoipRule.html
+++ b/docs/wafd/api-ref/DeleteGeoipRule.html
@@ -3,7 +3,7 @@
Deleting a Geolocation Access Control Rule
FunctionThis API is used to delete a geolocation access control rule.
- URIDELETE /v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}
+ URIDELETE /v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}
Table 1 Path ParametersParameter
|
@@ -30,7 +30,7 @@
String
|
-Policy ID
+ | Policy ID. It can be obtained by calling the ListPolicy API.
|
|---|
rule_id
@@ -39,7 +39,7 @@
|
String
|
-Rule ID
+ | ID of the geolocation access control rule. It can be obtained by calling the ListGeoipRules API.
|
@@ -104,6 +104,20 @@
Policy ID
|
+name
+ |
+String
+ |
+Rule name. Currently, the console does not support configuring names for geolocation access control rule. Ignore this parameter.
+ |
+
+geoTagList
+ |
+Array of strings
+ |
+List of geographical locations hit the geolocation access control rule.
+ |
+
geoip
|
String
@@ -130,6 +144,7 @@
South Africa: South Africa
Mexico: Mexico
Peru: Peru
+For more geographical location codes, see "Appendix - Geographic Location Codes."
|
@@ -264,6 +279,7 @@
"timestamp" : 1650534513775,
"description" : "demo",
"status" : 1,
+ "geoTagList" : [ "BR" ],
"geoip" : "BR",
"white" : 0
}
diff --git a/docs/wafd/api-ref/DeleteIgnoreRule.html b/docs/wafd/api-ref/DeleteIgnoreRule.html
index f25d00eb..1fa0f51a 100644
--- a/docs/wafd/api-ref/DeleteIgnoreRule.html
+++ b/docs/wafd/api-ref/DeleteIgnoreRule.html
@@ -1,9 +1,9 @@
-Deleting a False Alarm Masking Rule
-FunctionThis API is used to query a false alarm masking rule.
+ Deleting a Global Protection Whitelist (False Alarm Masking) Rule
+ FunctionThis API is used to deleting a global protection whitelist (false alarm masking) rule.
- URIDELETE /v1/{project_id}/waf/policy/{policy_id}/ignore/{rule_id}
+ URIDELETE /v1/{project_id}/waf/policy/{policy_id}/ignore/{rule_id}
| |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|