akyriako/web-application-firewall-dedicated
1
0
Fork 0
forked from docs/web-application-firewall-dedicated
Code Pull Requests Activity

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2023-06-02 09:09:13 +00:00
parent 691b6d2f2b
commit 8c02ce68d2
19 changed files with 172 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
api-ref/source/apis/managing_websites_protected_in_dedicated_mode/adding_a_protected_domain_name.rst
View File

@ -134,8 +134,6 @@ Response Parameters
+-----------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protect_status | Integer | WAF status of the protected domain name. |
| | | |
| | | - -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF. |
| | | |
| | | - 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. -1: Enabled. WAF detects attacks based on the configured policy. |
+-----------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| access_status | Integer | Whether a domain name is connected to WAF. |
@ -326,7 +324,7 @@ Example Requests
.. code-block:: text
POST https://{Endpoint}/v1/{project_id}/premium-waf/host?enterprise_project_id=0
POST https://{Endpoint}/v1/{project_id}/premium-waf/host?
{
"hostname" : "www.demo.com",

2
api-ref/source/apis/managing_websites_protected_in_dedicated_mode/deleting_a_domain_name_from_a_dedicated_waf_instance.rst
View File

@ -68,8 +68,6 @@ Response Parameters
+-----------------------+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| protect_status | Integer | WAF status of the protected domain name. The value can be: |
| | | |
| | | - -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF. |
| | | |
| | | - 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. |
| | | |
| | | - 1: Enabled. WAF detects attacks based on the configured policy. |

180
api-ref/source/apis/managing_websites_protected_in_dedicated_mode/modifying_a_domain_name_protected_by_a_dedicated_waf_instance.rst
View File

File diff suppressed because it is too large Load Diff

2
api-ref/source/apis/managing_websites_protected_in_dedicated_mode/querying_domain_names_protected_by_dedicated_waf_engines.rst
View File

@ -94,8 +94,6 @@ Response Parameters
+-----------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protect_status | Integer | WAF status of the protected domain name. The value can be: |
| | | |
| | | - -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF. |
| | | |
| | | - 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. |
| | | |
| | | - 1: Enabled. WAF detects attacks based on the configured policy. |

2
api-ref/source/apis/rule_management/creating_a_blacklist_or_whitelist_rule.rst
View File

@ -45,7 +45,7 @@ Request Parameters
+--------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+====================+=================+=================+============================================================================================================================================================================================================+
| name | No | String | Rule name. |
| name | Yes | String | Rule name. |
+--------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | No | String | Rule description. |
+--------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

8
api-ref/source/apis/rule_management/creating_a_geolocation_access_control_rule.rst
View File

@ -73,7 +73,9 @@ Request Parameters
| | | | |
| | | | - Israel: Israel |
| | | | |
| | | | - Iraq: Afghanistan |
| | | | - Iraq: Iraq |
| | | | |
| | | | - Afghanistan: Afghanistan |
| | | | |
| | | | - Libya: Libya |
| | | | |
@ -150,7 +152,9 @@ Response Parameters
| | | |
| | | - Israel: Israel |
| | | |
| | | - Iraq: Afghanistan |
| | | - Iraq: Iraq |
| | | |
| | | - Afghanistan: Afghanistan |
| | | |
| | | - Libya: Libya |
| | | |

6
api-ref/source/apis/rule_management/deleting_a_geolocation_access_control_rule.rst
View File

@ -88,7 +88,9 @@ Response Parameters
| | | |
| | | - Israel: Israel |
| | | |
| | | - Iraq: Afghanistan |
| | | - Iraq: Iraq |
| | | |
| | | - Afghanistan: Afghanistan |
| | | |
| | | - Libya: Libya |
| | | |
@ -163,7 +165,7 @@ Example Requests
.. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}?enterprise_project_id=0
DELETE https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}?
Example Responses
-----------------

2
api-ref/source/apis/rule_management/deleting_a_javascript_anti-crawler_rule.rst
View File

@ -45,7 +45,7 @@ Request Parameters
+=================+=================+=================+==============================================================================================================+
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API (value of **X-Subject-Token** in the response header). |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+
| Content-Type | Yes | String | Content type. |
| Content-Type | No | String | Content type. |
| | | | |
| | | | Default: **application/json;charset=utf8** |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+

16
api-ref/source/apis/rule_management/deleting_a_reference_table.rst
View File

@ -13,17 +13,17 @@ This API is used to delete a reference table.
URI
---
DELETE /v1/{project_id}/waf/valuelist/{table_id}
DELETE /v1/{project_id}/waf/valuelist/{valuelist_id}
.. table:: **Table 1** Path Parameters
+------------+-----------+--------+---------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+=============================================================================================+
| project_id | Yes | String | Project ID |
+------------+-----------+--------+---------------------------------------------------------------------------------------------+
| table_id | Yes | String | Reference table ID. It can be obtained by calling the API Querying the Reference Table List |
+------------+-----------+--------+---------------------------------------------------------------------------------------------+
+--------------+-----------+--------+---------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+=======================================================================================+
| project_id | Yes | String | Project ID |
+--------------+-----------+--------+---------------------------------------------------------------------------------------+
| valuelist_id | Yes | String | Valuelist ID. It can be obtained by calling the API Querying the Reference Table List |
+--------------+-----------+--------+---------------------------------------------------------------------------------------+
Request Parameters
------------------

4
api-ref/source/apis/rule_management/index.rst
View File

@ -58,7 +58,7 @@ Rule Management
- :ref:`Deleting a Geolocation Access Control Rule <deletegeoiprule>`
- :ref:`Querying the Reference Table List <listvaluelist>`
- :ref:`Creating a Reference Table <createvaluelist>`
- :ref:`Querying a Reference Table by ID <showvaluelist>`
- :ref:`Querying a Reference Table <showvaluelist>`
- :ref:`Modifying a Reference Table <updatevaluelist>`
- :ref:`Deleting a Reference Table <deletevaluelist>`
@ -119,6 +119,6 @@ Rule Management
deleting_a_geolocation_access_control_rule
querying_the_reference_table_list
creating_a_reference_table
querying_a_reference_table_by_id
querying_a_reference_table
modifying_a_reference_table
deleting_a_reference_table

16
api-ref/source/apis/rule_management/modifying_a_reference_table.rst
View File

@ -13,17 +13,17 @@ This API is used to modify a reference table.
URI
---
PUT /v1/{project_id}/waf/valuelist/{table_id}
PUT /v1/{project_id}/waf/valuelist/{valuelist_id}
.. table:: **Table 1** Path Parameters
+------------+-----------+--------+---------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+=============================================================================================+
| project_id | Yes | String | Project ID |
+------------+-----------+--------+---------------------------------------------------------------------------------------------+
| table_id | Yes | String | Reference table ID. It can be obtained by calling the API Querying the Reference Table List |
+------------+-----------+--------+---------------------------------------------------------------------------------------------+
+--------------+-----------+--------+---------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+=======================================================================================+
| project_id | Yes | String | Project ID |
+--------------+-----------+--------+---------------------------------------------------------------------------------------+
| valuelist_id | Yes | String | Valuelist ID. It can be obtained by calling the API Querying the Reference Table List |
+--------------+-----------+--------+---------------------------------------------------------------------------------------+
Request Parameters
------------------

6
api-ref/source/apis/rule_management/querying_a_geolocation_access_control_rule_by_id.rst
View File

@ -37,7 +37,7 @@ Request Parameters
+=================+=================+=================+============================================+
| X-Auth-Token | Yes | String | User token |
+-----------------+-----------------+-----------------+--------------------------------------------+
| Content-Type | Yes | String | Content type |
| Content-Type | No | String | Content type |
| | | | |
| | | | Default: **application/json;charset=utf8** |
+-----------------+-----------------+-----------------+--------------------------------------------+
@ -88,7 +88,9 @@ Response Parameters
| | | |
| | | - Israel: Israel |
| | | |
| | | - Iraq: Afghanistan |
| | | - Iraq: Iraq |
| | | |
| | | - Afghanistan: Afghanistan |
| | | |
| | | - Libya: Libya |
| | | |

2
api-ref/source/apis/rule_management/querying_a_javascript_anti-crawler_rule.rst
View File

@ -45,7 +45,7 @@ Request Parameters
+=================+=================+=================+==============================================================================================================+
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API (value of **X-Subject-Token** in the response header). |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+
| Content-Type | Yes | String | Content type. |
| Content-Type | No | String | Content type. |
| | | | |
| | | | Default: **application/json;charset=utf8** |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+

22
api-ref/source/apis/rule_management/querying_a_reference_table_by_id.rst → api-ref/source/apis/rule_management/querying_a_reference_table.rst
View File

@ -2,28 +2,28 @@
.. _ShowValueList:
Querying a Reference Table by ID
================================
Querying a Reference Table
==========================
Function
--------
This API is used to query a reference table by ID.
This API is used to query a reference table.
URI
---
GET /v1/{project_id}/waf/valuelist/{table_id}
GET /v1/{project_id}/waf/valuelist/{valuelist_id}
.. table:: **Table 1** Path Parameters
+------------+-----------+--------+---------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+=============================================================================================+
| project_id | Yes | String | Project ID |
+------------+-----------+--------+---------------------------------------------------------------------------------------------+
| table_id | Yes | String | Reference table ID. It can be obtained by calling the API Querying the Reference Table List |
+------------+-----------+--------+---------------------------------------------------------------------------------------------+
+--------------+-----------+--------+---------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+=======================================================================================+
| project_id | Yes | String | Project ID |
+--------------+-----------+--------+---------------------------------------------------------------------------------------+
| valuelist_id | Yes | String | Valuelist ID. It can be obtained by calling the API Querying the Reference Table List |
+--------------+-----------+--------+---------------------------------------------------------------------------------------+
Request Parameters
------------------

2
api-ref/source/apis/rule_management/querying_the_javascript_anti-crawler_rule_list.rst
View File

@ -53,7 +53,7 @@ Request Parameters
+=================+=================+=================+==============================================================================================================+
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API (value of **X-Subject-Token** in the response header). |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+
| Content-Type | Yes | String | Content type. |
| Content-Type | No | String | Content type. |
| | | | |
| | | | Default: **application/json;charset=utf8** |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+

4
api-ref/source/apis/rule_management/querying_the_list_of_geolocation_access_control_rules.rst
View File

@ -112,7 +112,9 @@ Response Parameters
| | | |
| | | - Israel: Israel |
| | | |
| | | - Iraq: Afghanistan |
| | | - Iraq: Iraq |
| | | |
| | | - Afghanistan: Afghanistan |
| | | |
| | | - Libya: Libya |
| | | |

8
api-ref/source/apis/rule_management/updating_a_geolocation_access_control_rule.rst
View File

@ -75,7 +75,9 @@ Request Parameters
| | | | |
| | | | - Israel: Israel |
| | | | |
| | | | - Iraq: Afghanistan |
| | | | - Iraq: Iraq |
| | | | |
| | | | - Afghanistan: Afghanistan |
| | | | |
| | | | - Libya: Libya |
| | | | |
@ -152,7 +154,9 @@ Response Parameters
| | | |
| | | - Israel: Israel |
| | | |
| | | - Iraq: Afghanistan |
| | | - Iraq: Iraq |
| | | |
| | | - Afghanistan: Afghanistan |
| | | |
| | | - Libya: Libya |
| | | |

2
api-ref/source/change_history.rst
View File

@ -8,6 +8,8 @@ Change History
+-----------------------------------+----------------------------------------------------------------------------------------------------+
| Released On | Description |
+===================================+====================================================================================================+
| 2023-04-23 | Revised the document based on review comments. |
+-----------------------------------+----------------------------------------------------------------------------------------------------+
| 2023-03-30 | - Added "Geographical Location Codes." |
| | - Revised the document based on review comments. |
+-----------------------------------+----------------------------------------------------------------------------------------------------+

2
api-ref/source/conf.py
View File

@ -18,7 +18,7 @@ import os
import sys
extensions = [
'otcdocstheme',
'otcdocstheme'
]
otcdocs_auto_name = False