|
912 | 912 | } |
913 | 913 | }, |
914 | 914 | "info": { |
915 | | - "description": "### DEPRECATED! Use v2alpha instead.\n\nGenerate a Web Application Firewall (WAF) to use with Application Load Balancers (ALB). The name of the WAF configuration is used in the listener of the ALB. This will activate the WAF for that ALB. An ALB with a WAF can have OWASP core rule set enabled and in addition can have custom rule configurations. To create a WAF one first needs to create all the configurations that are referenced in the WAF configuration. Currently this only consists of a rule configuration, which is written in Seclang. Once all configurations are created and referenced in the WAF configuration it can be used with an ALB. Currently updating a WAF configuration will not update an existing ALB until the Load Balancer VMs are restarted.", |
| 915 | + "description": "### DEPRECATED! Use v1beta instead.\n\nGenerate a Web Application Firewall (WAF) to use with Application Load Balancers (ALB). The name of the WAF configuration is used in the listener of the ALB. This will activate the WAF for that ALB. An ALB with a WAF can have OWASP core rule set enabled and in addition can have custom rule configurations. To create a WAF one first needs to create all the configurations that are referenced in the WAF configuration. Currently this only consists of a rule configuration, which is written in Seclang. Once all configurations are created and referenced in the WAF configuration it can be used with an ALB. Currently updating a WAF configuration will not update an existing ALB until the Load Balancer VMs are restarted.", |
916 | 916 | "title": "STACKIT Application Load Balancer Web Application Firewall API", |
917 | 917 | "version": "1alpha.0.0" |
918 | 918 | }, |
919 | 919 | "openapi": "3.0.3", |
920 | 920 | "paths": { |
921 | 921 | "/v1alpha/projects/{projectId}/regions/{region}/core-rule-sets": { |
922 | 922 | "get": { |
| 923 | + "deprecated": true, |
923 | 924 | "description": "List all existing core rule set (CRS) configurations that are stored in the project.", |
924 | 925 | "operationId": "ListCoreRuleSets", |
925 | 926 | "parameters": [ |
|
1016 | 1017 | } |
1017 | 1018 | }, |
1018 | 1019 | "post": { |
| 1020 | + "deprecated": true, |
1019 | 1021 | "description": "With this endpoint a core rule set (CRS) configuration is created and stored in this project. Currently it is only possible to enable it. This rule configuration is supposed to be referenced by a WAF configuration. It can be referenced by any number of WAF configurations in the same project.", |
1020 | 1022 | "operationId": "CreateCoreRuleSet", |
1021 | 1023 | "parameters": [ |
|
1108 | 1110 | }, |
1109 | 1111 | "/v1alpha/projects/{projectId}/regions/{region}/core-rule-sets/{name}": { |
1110 | 1112 | "delete": { |
| 1113 | + "deprecated": true, |
1111 | 1114 | "description": "To delete a core rule set (CRS) configuration this endpoint is used, but it is only possible to delete it if no WAF configuration is referencing it.", |
1112 | 1115 | "operationId": "DeleteCoreRuleSet", |
1113 | 1116 | "parameters": [ |
|
1193 | 1196 | } |
1194 | 1197 | }, |
1195 | 1198 | "get": { |
| 1199 | + "deprecated": true, |
1196 | 1200 | "description": "To retrieve an existing core rule set (CRS) configuration this endpoint can be used.", |
1197 | 1201 | "operationId": "GetCoreRuleSet", |
1198 | 1202 | "parameters": [ |
|
1281 | 1285 | } |
1282 | 1286 | }, |
1283 | 1287 | "patch": { |
| 1288 | + "deprecated": true, |
1284 | 1289 | "description": "Accepts the same structure as the GET response. Only fields provided with values will be updated.", |
1285 | 1290 | "operationId": "PatchCoreRuleSet", |
1286 | 1291 | "parameters": [ |
|
1374 | 1379 | } |
1375 | 1380 | }, |
1376 | 1381 | "put": { |
| 1382 | + "deprecated": true, |
1377 | 1383 | "description": "DEPRECATED: Use PatchCoreRuleSet", |
1378 | 1384 | "operationId": "UpdateCoreRuleSet", |
1379 | 1385 | "parameters": [ |
|
1474 | 1480 | }, |
1475 | 1481 | "/v1alpha/projects/{projectId}/regions/{region}/quotas": { |
1476 | 1482 | "get": { |
| 1483 | + "deprecated": true, |
1477 | 1484 | "description": "Retrieves the configured WAF resource quotas for the project. Limit can be changed via service request.", |
1478 | 1485 | "operationId": "GetQuota", |
1479 | 1486 | "parameters": [ |
|
1553 | 1560 | }, |
1554 | 1561 | "/v1alpha/projects/{projectId}/regions/{region}/rules": { |
1555 | 1562 | "get": { |
| 1563 | + "deprecated": true, |
1556 | 1564 | "description": "List all existing rule configurations that are stored in the project.", |
1557 | 1565 | "operationId": "ListRules", |
1558 | 1566 | "parameters": [ |
|
1649 | 1657 | } |
1650 | 1658 | }, |
1651 | 1659 | "post": { |
| 1660 | + "deprecated": true, |
1652 | 1661 | "description": "With this endpoint a rule configuration is created and stored in this project. The rules are written in Seclang. This rule configuration is supposed to be referenced by a WAF configuration. It can be referenced by any number of WAF configurations in the same project. There is a limit of 1 MB of data on these rules.", |
1653 | 1662 | "operationId": "CreateRules", |
1654 | 1663 | "parameters": [ |
|
1741 | 1750 | }, |
1742 | 1751 | "/v1alpha/projects/{projectId}/regions/{region}/rules/{name}": { |
1743 | 1752 | "delete": { |
| 1753 | + "deprecated": true, |
1744 | 1754 | "description": "To delete a rule configuration this endpoint is used, but it is only possible to delete it if no WAF configuration is referencing it.", |
1745 | 1755 | "operationId": "DeleteRules", |
1746 | 1756 | "parameters": [ |
|
1826 | 1836 | } |
1827 | 1837 | }, |
1828 | 1838 | "get": { |
| 1839 | + "deprecated": true, |
1829 | 1840 | "description": "To retrieve an existing rule configuration this endpoint can be used.", |
1830 | 1841 | "operationId": "GetRules", |
1831 | 1842 | "parameters": [ |
|
1914 | 1925 | } |
1915 | 1926 | }, |
1916 | 1927 | "put": { |
| 1928 | + "deprecated": true, |
1917 | 1929 | "description": "This endpoint will update an existing rules configuration and also inturn update all WAF configurations that reference it. There is a limit of 1 MB of data on these rules.", |
1918 | 1930 | "operationId": "UpdateRules", |
1919 | 1931 | "parameters": [ |
|
2014 | 2026 | }, |
2015 | 2027 | "/v1alpha/projects/{projectId}/regions/{region}/wafs": { |
2016 | 2028 | "get": { |
| 2029 | + "deprecated": true, |
2017 | 2030 | "description": "To list all WAF configurations stored in a project, use this endpoint.", |
2018 | 2031 | "operationId": "ListWAF", |
2019 | 2032 | "parameters": [ |
|
2110 | 2123 | } |
2111 | 2124 | }, |
2112 | 2125 | "post": { |
| 2126 | + "deprecated": true, |
2113 | 2127 | "description": "This endpoint will create and store a WAF configuration in a project. The name of this WAF configuration is supposed to be used in the listener of an Application Load Balancer, which will activate this configuration and in addition it is possible to enable the core rule set. This WAF configuration can be used by any number of Application Load Balancers in the same project. The configuration has a reference to a rule configuration. This rule configuration has to exist when trying to create a WAF configuration. Later other configuration references will be added to this object.", |
2114 | 2128 | "operationId": "CreateWAF", |
2115 | 2129 | "parameters": [ |
|
2202 | 2216 | }, |
2203 | 2217 | "/v1alpha/projects/{projectId}/regions/{region}/wafs/{name}": { |
2204 | 2218 | "delete": { |
| 2219 | + "deprecated": true, |
2205 | 2220 | "description": "This will delete the specified WAF configuration, but only if it is not used by any Application Load Balancer in the project.", |
2206 | 2221 | "operationId": "DeleteWAF", |
2207 | 2222 | "parameters": [ |
|
2287 | 2302 | } |
2288 | 2303 | }, |
2289 | 2304 | "get": { |
| 2305 | + "deprecated": true, |
2290 | 2306 | "description": "This endpoint will return the specified WAF configuration.", |
2291 | 2307 | "operationId": "GetWAF", |
2292 | 2308 | "parameters": [ |
|
2375 | 2391 | } |
2376 | 2392 | }, |
2377 | 2393 | "put": { |
| 2394 | + "deprecated": true, |
2378 | 2395 | "description": "The update endpoint will update a stored WAF configuration in project and not yet but later will also update the Load Balancers that reference it.", |
2379 | 2396 | "operationId": "UpdateWAF", |
2380 | 2397 | "parameters": [ |
|
0 commit comments