vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

WAF Dedicated API Reference 20230605 Version.

Browse Source 
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: Li, Qiao <qiaoli@huawei.com>
Co-committed-by: Li, Qiao <qiaoli@huawei.com>
This commit is contained in:
Li, Qiao 2024-01-17 14:22:09 +00:00 committed by zuul
parent a5cc543164
commit c992ff71da
20 changed files with 288 additions and 179 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/wafd/api-ref/ALL_META.TXT.json
View File

@ -763,17 +763,17 @@
"uri":"ShowValueList.html",
"product_code":"wafd",
"code":"77",
"des":"This API is used to query a reference table by ID.GET /v1/{project_id}/waf/valuelist/{table_id}Status code: 200Status code: 400Status code: 401Status code: 500Status code",
"des":"This API is used to query a reference table.GET /v1/{project_id}/waf/valuelist/{valuelist_id}Status code: 200Status code: 400Status code: 401Status code: 500Status code: ",
"doc_type":"api",
"kw":"Querying a Reference Table by ID,Rule Management,API Reference",
"title":"Querying a Reference Table by ID",
"kw":"Querying a Reference Table,Rule Management,API Reference",
"title":"Querying a Reference Table",
"githuburl":""
},
{
"uri":"UpdateValueList.html",
"product_code":"wafd",
"code":"78",
"des":"This API is used to modify a reference table.PUT /v1/{project_id}/waf/valuelist/{table_id}Status code: 200Status code: 400Status code: 401Status code: 500Status code: 200",
"des":"This API is used to modify a reference table.PUT /v1/{project_id}/waf/valuelist/{valuelist_id}Status code: 200Status code: 400Status code: 401Status code: 500Status code:",
"doc_type":"api",
"kw":"Modifying a Reference Table,Rule Management,API Reference",
"title":"Modifying a Reference Table",
@ -783,7 +783,7 @@
"uri":"DeleteValueList.html",
"product_code":"wafd",
"code":"79",
"des":"This API is used to delete a reference table.DELETE /v1/{project_id}/waf/valuelist/{table_id}Status code: 200Status code: 400Status code: 401Status code: 500Status code: ",
"des":"This API is used to delete a reference table.DELETE /v1/{project_id}/waf/valuelist/{valuelist_id}Status code: 200Status code: 400Status code: 401Status code: 500Status co",
"doc_type":"api",
"kw":"Deleting a Reference Table,Rule Management,API Reference",
"title":"Deleting a Reference Table",

8
docs/wafd/api-ref/CLASS.TXT.json
View File

@ -684,16 +684,16 @@
"code":"76"
},
{
"desc":"This API is used to query a reference table by ID.GET /v1/{project_id}/waf/valuelist/{table_id}Status code: 200Status code: 400Status code: 401Status code: 500Status code",
"desc":"This API is used to query a reference table.GET /v1/{project_id}/waf/valuelist/{valuelist_id}Status code: 200Status code: 400Status code: 401Status code: 500Status code: ",
"product_code":"wafd",
"title":"Querying a Reference Table by ID",
"title":"Querying a Reference Table",
"uri":"ShowValueList.html",
"doc_type":"api",
"p_code":"23",
"code":"77"
},
{
"desc":"This API is used to modify a reference table.PUT /v1/{project_id}/waf/valuelist/{table_id}Status code: 200Status code: 400Status code: 401Status code: 500Status code: 200",
"desc":"This API is used to modify a reference table.PUT /v1/{project_id}/waf/valuelist/{valuelist_id}Status code: 200Status code: 400Status code: 401Status code: 500Status code:",
"product_code":"wafd",
"title":"Modifying a Reference Table",
"uri":"UpdateValueList.html",
@ -702,7 +702,7 @@
"code":"78"
},
{
"desc":"This API is used to delete a reference table.DELETE /v1/{project_id}/waf/valuelist/{table_id}Status code: 200Status code: 400Status code: 401Status code: 500Status code: ",
"desc":"This API is used to delete a reference table.DELETE /v1/{project_id}/waf/valuelist/{valuelist_id}Status code: 200Status code: 400Status code: 401Status code: 500Status co",
"product_code":"wafd",
"title":"Deleting a Reference Table",
"uri":"DeleteValueList.html",

6
docs/wafd/api-ref/CreateGeoipRule.html
View File

@ -101,7 +101,8 @@
</li><li><p>Pakistan: Pakistan</p>
</li><li><p>Palestine: Palestine</p>
</li><li><p>Israel: Israel</p>
</li><li><p>Iraq: Afghanistan</p>
</li><li><p>Iraq: Iraq</p>
</li><li><p>Afghanistan: Afghanistan</p>
</li><li><p>Libya: Libya</p>
</li><li><p>Turkey: Turkey</p>
</li><li><p>Thailand: Thailand</p>
@ -204,7 +205,8 @@
</li><li><p>Pakistan: Pakistan</p>
</li><li><p>Palestine: Palestine</p>
</li><li><p>Israel: Israel</p>
</li><li><p>Iraq: Afghanistan</p>
</li><li><p>Iraq: Iraq</p>
</li><li><p>Afghanistan: Afghanistan</p>
</li><li><p>Libya: Libya</p>
</li><li><p>Turkey: Turkey</p>
</li><li><p>Thailand: Thailand</p>

5
docs/wafd/api-ref/CreatePremiumHost.html
View File

@ -301,8 +301,7 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>WAF status of the protected domain name.</p>
<ul><li><p>-1: Bypassed. Requests are directly sent to the backend servers without passing through WAF.</p>
</li><li><p>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.</p>
<ul><li><p>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.</p>
</li></ul>
</td>
</tr>
@ -680,7 +679,7 @@
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><pre class="screen">POST https://{Endpoint}/v1/{project_id}/premium-waf/host?enterprise_project_id=0
<div class="section"><h4 class="sectiontitle">Example Requests</h4><pre class="screen">POST https://{Endpoint}/v1/{project_id}/premium-waf/host?
{
"hostname" : "www.demo.com",

2
docs/wafd/api-ref/CreateWhiteblackipRule.html
View File

@ -83,7 +83,7 @@
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>No</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
</td>

2
docs/wafd/api-ref/DeleteAnticrawlerRule.html
View File

@ -91,7 +91,7 @@
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>

5
docs/wafd/api-ref/DeleteGeoipRule.html
View File

@ -136,7 +136,8 @@
</li><li><p>Pakistan: Pakistan</p>
</li><li><p>Palestine: Palestine</p>
</li><li><p>Israel: Israel</p>
</li><li><p>Iraq: Afghanistan</p>
</li><li><p>Iraq: Iraq</p>
</li><li><p>Afghanistan: Afghanistan</p>
</li><li><p>Libya: Libya</p>
</li><li><p>Turkey: Turkey</p>
</li><li><p>Thailand: Thailand</p>
@ -268,7 +269,7 @@
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><pre class="screen">DELETE https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}?enterprise_project_id=0</pre>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><pre class="screen">DELETE https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}?</pre>
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
<p>Request succeeded.</p>

3
docs/wafd/api-ref/DeletePremiumHost.html
View File

@ -131,8 +131,7 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>WAF status of the protected domain name. The value can be:</p>
<ul><li><p>-1: Bypassed. Requests are directly sent to the backend servers without passing through WAF.</p>
</li><li><p>0: Suspended. WAF only forwards requests for the domain name but does not detect attacks.</p>
<ul><li><p>0: Suspended. WAF only forwards requests for the domain name but does not detect attacks.</p>
</li><li><p>1: Enabled. WAF detects attacks based on the configured policy.</p>
</li></ul>
</td>

6
docs/wafd/api-ref/DeleteValueList.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Deleting a Reference Table</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete a reference table.</p>
</div>
<div class="section" id="DeleteValueList__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>DELETE /v1/{project_id}/waf/valuelist/{table_id}</p>
<div class="section" id="DeleteValueList__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>DELETE /v1/{project_id}/waf/valuelist/{valuelist_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -24,13 +24,13 @@
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Project ID</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>table_id</p>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>valuelist_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Reference table ID. It can be obtained by calling the API Querying the Reference Table List</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Valuelist ID. It can be obtained by calling the API Querying the Reference Table List</p>
</td>
</tr>
</tbody>

2
docs/wafd/api-ref/ListAnticrawlerRules.html
View File

@ -112,7 +112,7 @@
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>

3
docs/wafd/api-ref/ListGeoipRules.html
View File

@ -187,7 +187,8 @@
</li><li><p>Pakistan: Pakistan</p>
</li><li><p>Palestine: Palestine</p>
</li><li><p>Israel: Israel</p>
</li><li><p>Iraq: Afghanistan</p>
</li><li><p>Iraq: Iraq</p>
</li><li><p>Afghanistan: Afghanistan</p>
</li><li><p>Libya: Libya</p>
</li><li><p>Turkey: Turkey</p>
</li><li><p>Thailand: Thailand</p>

3
docs/wafd/api-ref/ListPremiumHost.html
View File

@ -189,8 +189,7 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>WAF status of the protected domain name. The value can be:</p>
<ul><li><p>-1: Bypassed. Requests are directly sent to the backend servers without passing through WAF.</p>
</li><li><p>0: Suspended. WAF only forwards requests for the domain name but does not detect attacks.</p>
<ul><li><p>0: Suspended. WAF only forwards requests for the domain name but does not detect attacks.</p>
</li><li><p>1: Enabled. WAF detects attacks based on the configured policy.</p>
</li></ul>
</td>

2
docs/wafd/api-ref/ShowAnticrawlerRule.html
View File

@ -91,7 +91,7 @@
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>

5
docs/wafd/api-ref/ShowGeoipRule.html
View File

@ -68,7 +68,7 @@
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
@ -136,7 +136,8 @@
</li><li><p>Pakistan: Pakistan</p>
</li><li><p>Palestine: Palestine</p>
</li><li><p>Israel: Israel</p>
</li><li><p>Iraq: Afghanistan</p>
</li><li><p>Iraq: Iraq</p>
</li><li><p>Afghanistan: Afghanistan</p>
</li><li><p>Libya: Libya</p>
</li><li><p>Turkey: Turkey</p>
</li><li><p>Thailand: Thailand</p>

10
docs/wafd/api-ref/ShowValueList.html
View File

@ -1,9 +1,9 @@
<a name="ShowValueList"></a><a name="ShowValueList"></a>
<h1 class="topictitle1">Querying a Reference Table by ID</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query a reference table by ID.</p>
<h1 class="topictitle1">Querying a Reference Table</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query a reference table.</p>
</div>
<div class="section" id="ShowValueList__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v1/{project_id}/waf/valuelist/{table_id}</p>
<div class="section" id="ShowValueList__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v1/{project_id}/waf/valuelist/{valuelist_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -24,13 +24,13 @@
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Project ID</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>table_id</p>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>valuelist_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Reference table ID. It can be obtained by calling the API Querying the Reference Table List</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Valuelist ID. It can be obtained by calling the API Querying the Reference Table List</p>
</td>
</tr>
</tbody>

6
docs/wafd/api-ref/UpdateGeoipRule.html
View File

@ -110,7 +110,8 @@
</li><li><p>Pakistan: Pakistan</p>
</li><li><p>Palestine: Palestine</p>
</li><li><p>Israel: Israel</p>
</li><li><p>Iraq: Afghanistan</p>
</li><li><p>Iraq: Iraq</p>
</li><li><p>Afghanistan: Afghanistan</p>
</li><li><p>Libya: Libya</p>
</li><li><p>Turkey: Turkey</p>
</li><li><p>Thailand: Thailand</p>
@ -213,7 +214,8 @@
</li><li><p>Pakistan: Pakistan</p>
</li><li><p>Palestine: Palestine</p>
</li><li><p>Israel: Israel</p>
</li><li><p>Iraq: Afghanistan</p>
</li><li><p>Iraq: Iraq</p>
</li><li><p>Afghanistan: Afghanistan</p>
</li><li><p>Libya: Libya</p>
</li><li><p>Turkey: Turkey</p>
</li><li><p>Thailand: Thailand</p>

374
docs/wafd/api-ref/UpdatePremiumHost.html
View File

File diff suppressed because it is too large Load Diff

6
docs/wafd/api-ref/UpdateValueList.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Modifying a Reference Table</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to modify a reference table.</p>
</div>
<div class="section" id="UpdateValueList__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>PUT /v1/{project_id}/waf/valuelist/{table_id}</p>
<div class="section" id="UpdateValueList__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>PUT /v1/{project_id}/waf/valuelist/{valuelist_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -24,13 +24,13 @@
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Project ID</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>table_id</p>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>valuelist_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Reference table ID. It can be obtained by calling the API Querying the Reference Table List</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Valuelist ID. It can be obtained by calling the API Querying the Reference Table List</p>
</td>
</tr>
</tbody>

2
docs/wafd/api-ref/topic_300000003.html
View File

@ -111,7 +111,7 @@
</li>
<li class="ulchildlink"><strong><a href="CreateValueList.html">Creating a Reference Table</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ShowValueList.html">Querying a Reference Table by ID</a></strong><br>
<li class="ulchildlink"><strong><a href="ShowValueList.html">Querying a Reference Table</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="UpdateValueList.html">Modifying a Reference Table</a></strong><br>
</li>

7
docs/wafd/api-ref/waf_02_0087.html
View File

@ -8,7 +8,12 @@
</th>
</tr>
</thead>
<tbody><tr id="waf_02_0087__row18372122183716"><td class="cellrowborder" valign="top" width="27.200000000000003%" headers="mcps1.3.1.1.3.1.1 "><p id="waf_02_0087__p163725212372">2023-03-30</p>
<tbody><tr id="waf_02_0087__row1355794533517"><td class="cellrowborder" valign="top" width="27.200000000000003%" headers="mcps1.3.1.1.3.1.1 "><p id="waf_02_0087__p45571545103518">2023-04-23</p>
</td>
<td class="cellrowborder" valign="top" width="72.8%" headers="mcps1.3.1.1.3.1.2 "><p id="waf_02_0087__p175576453355">Revised the document based on review comments.</p>
</td>
</tr>
<tr id="waf_02_0087__row18372122183716"><td class="cellrowborder" valign="top" width="27.200000000000003%" headers="mcps1.3.1.1.3.1.1 "><p id="waf_02_0087__p163725212372">2023-03-30</p>
</td>
<td class="cellrowborder" valign="top" width="72.8%" headers="mcps1.3.1.1.3.1.2 "><ul id="waf_02_0087__ul6847716123919"><li id="waf_02_0087__li1384717161396">Added "Geographical Location Codes."</li><li id="waf_02_0087__li156326183394">Revised the document based on review comments.</li></ul>
</td>