fastly 5.3.1 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (200) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +55 -0
  3. data/Gemfile.lock +1 -1
  4. data/README.md +85 -63
  5. data/docs/AclEntry.md +1 -1
  6. data/docs/AclEntryApi.md +176 -0
  7. data/docs/AclEntryResponse.md +1 -1
  8. data/docs/ApexRedirectApi.md +56 -0
  9. data/docs/BulkUpdateAclEntry.md +1 -1
  10. data/docs/ClientKey.md +12 -0
  11. data/docs/ContactApi.md +50 -0
  12. data/docs/Content.md +2 -2
  13. data/docs/ContentApi.md +52 -0
  14. data/docs/DirectorApi.md +42 -0
  15. data/docs/DomainInspector.md +12 -0
  16. data/docs/DomainInspectorEntry.md +11 -0
  17. data/docs/DomainInspectorEntryDimensions.md +12 -0
  18. data/docs/DomainInspectorHistoricalApi.md +72 -0
  19. data/docs/DomainInspectorMeasurements.md +71 -0
  20. data/docs/DomainInspectorRealtimeApi.md +132 -0
  21. data/docs/DomainInspectorRealtimeEntry.md +12 -0
  22. data/docs/EventAttributes.md +1 -1
  23. data/docs/{EventsResponseAllOf.md → EventData.md} +1 -1
  24. data/docs/HistoricalDomains.md +13 -0
  25. data/docs/HistoricalDomainsData.md +11 -0
  26. data/docs/HistoricalDomainsMeta.md +18 -0
  27. data/docs/HistoricalDomainsMetaFilters.md +12 -0
  28. data/docs/HistoricalDomainsResponse.md +13 -0
  29. data/docs/HistoricalDomainsResponseAllOf.md +10 -0
  30. data/docs/{HistoricalFieldResultsAttributesAllOf.md → HistoricalFieldResultsAttributesAdditional.md} +1 -1
  31. data/docs/HistoricalOriginsResponse.md +13 -0
  32. data/docs/HistoricalOriginsResponseAllOf.md +10 -0
  33. data/docs/IamRolesApi.md +157 -0
  34. data/docs/IamServiceGroupsApi.md +157 -0
  35. data/docs/IamUserGroupsApi.md +315 -0
  36. data/docs/InlineResponse2005.md +11 -0
  37. data/docs/InlineResponse2006.md +11 -0
  38. data/docs/InlineResponse2007.md +10 -0
  39. data/docs/InlineResponse400.md +10 -0
  40. data/docs/LegacyWafConfigurationSet.md +11 -0
  41. data/docs/LegacyWafConfigurationSetsApi.md +125 -0
  42. data/docs/LegacyWafFirewall.md +18 -0
  43. data/docs/LegacyWafFirewallApi.md +352 -0
  44. data/docs/LegacyWafOwasp.md +38 -0
  45. data/docs/LegacyWafOwaspApi.md +138 -0
  46. data/docs/LegacyWafRule.md +14 -0
  47. data/docs/LegacyWafRuleApi.md +184 -0
  48. data/docs/LegacyWafRuleStatus.md +12 -0
  49. data/docs/LegacyWafRuleStatusApi.md +202 -0
  50. data/docs/LegacyWafRuleset.md +11 -0
  51. data/docs/LegacyWafRulesetApi.md +136 -0
  52. data/docs/LegacyWafTag.md +10 -0
  53. data/docs/LegacyWafTagApi.md +58 -0
  54. data/docs/LegacyWafUpdateStatus.md +15 -0
  55. data/docs/LegacyWafUpdateStatusApi.md +102 -0
  56. data/docs/LoggingKafkaApi.md +42 -0
  57. data/docs/LoggingKinesisApi.md +42 -0
  58. data/docs/OriginInspector.md +12 -0
  59. data/docs/OriginInspectorDimensions.md +12 -0
  60. data/docs/OriginInspectorEntry.md +11 -0
  61. data/docs/OriginInspectorHistorical.md +13 -0
  62. data/docs/OriginInspectorHistoricalApi.md +72 -0
  63. data/docs/OriginInspectorHistoricalData.md +11 -0
  64. data/docs/OriginInspectorHistoricalMeta.md +18 -0
  65. data/docs/OriginInspectorHistoricalMetaFilters.md +12 -0
  66. data/docs/OriginInspectorMeasurements.md +161 -0
  67. data/docs/OriginInspectorRealtimeApi.md +132 -0
  68. data/docs/OriginInspectorRealtimeEntry.md +12 -0
  69. data/docs/OriginInspectorRealtimeEntryRecorded.md +9 -0
  70. data/docs/OriginInspectorSubsequentRequestTimestamp.md +9 -0
  71. data/docs/OriginInspectorValues.md +161 -0
  72. data/docs/PaginationCursorMeta.md +11 -0
  73. data/docs/ReadOnlyServiceId.md +9 -0
  74. data/docs/ReadOnlyVersion.md +9 -0
  75. data/docs/RealtimeEntry.md +2 -2
  76. data/docs/RealtimeEntryAggregated.md +227 -0
  77. data/docs/RealtimeEntryRecorded.md +9 -0
  78. data/docs/RealtimeMeasurements.md +1 -1
  79. data/docs/RecordedTimestamp.md +9 -0
  80. data/docs/RequestSettingsApi.md +40 -0
  81. data/docs/ResponseObjectApi.md +82 -0
  82. data/docs/Secret.md +12 -0
  83. data/docs/SecretResponse.md +13 -0
  84. data/docs/SecretStore.md +10 -0
  85. data/docs/SecretStoreApi.md +233 -0
  86. data/docs/SecretStoreItemApi.md +255 -0
  87. data/docs/SecretStoreResponse.md +12 -0
  88. data/docs/ServiceAuthorizationsApi.md +76 -0
  89. data/docs/SigningKey.md +10 -0
  90. data/docs/SnippetApi.md +42 -0
  91. data/docs/SubsequentRequestTimestamp.md +9 -0
  92. data/docs/SudoApi.md +52 -0
  93. data/docs/SudoGenericTokenError.md +10 -0
  94. data/docs/SudoRequest.md +12 -0
  95. data/docs/SudoResponse.md +10 -0
  96. data/docs/TokensApi.md +70 -0
  97. data/docs/Values.md +71 -0
  98. data/docs/WafActiveRulesApi.md +41 -0
  99. data/lib/fastly/api/acl_entry_api.rb +332 -0
  100. data/lib/fastly/api/apex_redirect_api.rb +111 -0
  101. data/lib/fastly/api/contact_api.rb +90 -0
  102. data/lib/fastly/api/content_api.rb +79 -0
  103. data/lib/fastly/api/director_api.rb +82 -0
  104. data/lib/fastly/api/domain_inspector_historical_api.rb +125 -0
  105. data/lib/fastly/api/domain_inspector_realtime_api.rb +223 -0
  106. data/lib/fastly/api/iam_roles_api.rb +271 -0
  107. data/lib/fastly/api/iam_service_groups_api.rb +271 -0
  108. data/lib/fastly/api/iam_user_groups_api.rb +547 -0
  109. data/lib/fastly/api/legacy_waf_configuration_sets_api.rb +209 -0
  110. data/lib/fastly/api/legacy_waf_firewall_api.rb +627 -0
  111. data/lib/fastly/api/legacy_waf_owasp_api.rb +244 -0
  112. data/lib/fastly/api/legacy_waf_rule_api.rb +307 -0
  113. data/lib/fastly/api/legacy_waf_rule_status_api.rb +366 -0
  114. data/lib/fastly/api/legacy_waf_ruleset_api.rb +237 -0
  115. data/lib/fastly/api/legacy_waf_tag_api.rb +96 -0
  116. data/lib/fastly/api/legacy_waf_update_status_api.rb +184 -0
  117. data/lib/fastly/api/logging_kafka_api.rb +82 -0
  118. data/lib/fastly/api/logging_kinesis_api.rb +82 -0
  119. data/lib/fastly/api/origin_inspector_historical_api.rb +125 -0
  120. data/lib/fastly/api/origin_inspector_realtime_api.rb +223 -0
  121. data/lib/fastly/api/request_settings_api.rb +75 -0
  122. data/lib/fastly/api/response_object_api.rb +157 -0
  123. data/lib/fastly/api/secret_store_api.rb +381 -0
  124. data/lib/fastly/api/secret_store_item_api.rb +437 -0
  125. data/lib/fastly/api/service_authorizations_api.rb +126 -0
  126. data/lib/fastly/api/snippet_api.rb +82 -0
  127. data/lib/fastly/api/sudo_api.rb +83 -0
  128. data/lib/fastly/api/tokens_api.rb +122 -0
  129. data/lib/fastly/api/waf_active_rules_api.rb +75 -0
  130. data/lib/fastly/configuration.rb +504 -0
  131. data/lib/fastly/models/acl_entry.rb +1 -1
  132. data/lib/fastly/models/acl_entry_response.rb +1 -1
  133. data/lib/fastly/models/bulk_update_acl_entry.rb +1 -1
  134. data/lib/fastly/models/client_key.rb +239 -0
  135. data/lib/fastly/models/content.rb +8 -4
  136. data/lib/fastly/models/domain.rb +1 -0
  137. data/lib/fastly/models/domain_inspector.rb +238 -0
  138. data/lib/fastly/models/domain_inspector_entry.rb +228 -0
  139. data/lib/fastly/models/domain_inspector_entry_dimensions.rb +238 -0
  140. data/lib/fastly/models/domain_inspector_measurements.rb +828 -0
  141. data/lib/fastly/models/domain_inspector_realtime_entry.rb +241 -0
  142. data/lib/fastly/models/event_attributes.rb +4 -2
  143. data/lib/fastly/models/{events_response_all_of.rb → event_data.rb} +3 -3
  144. data/lib/fastly/models/events_response.rb +1 -1
  145. data/lib/fastly/models/historical_domains.rb +249 -0
  146. data/lib/fastly/models/historical_domains_data.rb +228 -0
  147. data/lib/fastly/models/historical_domains_meta.rb +297 -0
  148. data/lib/fastly/models/historical_domains_meta_filters.rb +235 -0
  149. data/lib/fastly/models/historical_domains_response.rb +257 -0
  150. data/lib/fastly/models/historical_domains_response_all_of.rb +219 -0
  151. data/lib/fastly/models/historical_field_results_attributes.rb +1 -1
  152. data/lib/fastly/models/{historical_field_results_attributes_all_of.rb → historical_field_results_attributes_additional.rb} +3 -3
  153. data/lib/fastly/models/historical_origins_response.rb +257 -0
  154. data/lib/fastly/models/historical_origins_response_all_of.rb +219 -0
  155. data/lib/fastly/models/inline_response2005.rb +227 -0
  156. data/lib/fastly/models/inline_response2006.rb +227 -0
  157. data/lib/fastly/models/inline_response2007.rb +218 -0
  158. data/lib/fastly/models/inline_response400.rb +250 -0
  159. data/lib/fastly/models/legacy_waf_configuration_set.rb +227 -0
  160. data/lib/fastly/models/legacy_waf_firewall.rb +297 -0
  161. data/lib/fastly/models/legacy_waf_owasp.rb +527 -0
  162. data/lib/fastly/models/legacy_waf_rule.rb +257 -0
  163. data/lib/fastly/models/legacy_waf_rule_status.rb +237 -0
  164. data/lib/fastly/models/legacy_waf_ruleset.rb +227 -0
  165. data/lib/fastly/models/legacy_waf_tag.rb +217 -0
  166. data/lib/fastly/models/legacy_waf_update_status.rb +267 -0
  167. data/lib/fastly/models/origin_inspector.rb +238 -0
  168. data/lib/fastly/models/origin_inspector_dimensions.rb +238 -0
  169. data/lib/fastly/models/origin_inspector_entry.rb +228 -0
  170. data/lib/fastly/models/origin_inspector_historical.rb +249 -0
  171. data/lib/fastly/models/origin_inspector_historical_data.rb +225 -0
  172. data/lib/fastly/models/origin_inspector_historical_meta.rb +297 -0
  173. data/lib/fastly/models/origin_inspector_historical_meta_filters.rb +235 -0
  174. data/lib/fastly/models/origin_inspector_measurements.rb +1728 -0
  175. data/lib/fastly/models/origin_inspector_realtime_entry.rb +241 -0
  176. data/lib/fastly/models/origin_inspector_realtime_entry_recorded.rb +208 -0
  177. data/lib/fastly/models/origin_inspector_subsequent_request_timestamp.rb +208 -0
  178. data/lib/fastly/models/origin_inspector_values.rb +1728 -0
  179. data/lib/fastly/models/pagination_cursor_meta.rb +227 -0
  180. data/lib/fastly/models/read_only_service_id.rb +207 -0
  181. data/lib/fastly/models/read_only_version.rb +207 -0
  182. data/lib/fastly/models/realtime_entry.rb +2 -7
  183. data/lib/fastly/models/realtime_entry_aggregated.rb +2397 -0
  184. data/lib/fastly/models/realtime_entry_recorded.rb +208 -0
  185. data/lib/fastly/models/realtime_measurements.rb +4 -2
  186. data/lib/fastly/models/recorded_timestamp.rb +208 -0
  187. data/lib/fastly/models/secret.rb +238 -0
  188. data/lib/fastly/models/secret_response.rb +249 -0
  189. data/lib/fastly/models/secret_store.rb +217 -0
  190. data/lib/fastly/models/secret_store_response.rb +238 -0
  191. data/lib/fastly/models/signing_key.rb +218 -0
  192. data/lib/fastly/models/subsequent_request_timestamp.rb +208 -0
  193. data/lib/fastly/models/sudo_generic_token_error.rb +216 -0
  194. data/lib/fastly/models/sudo_request.rb +244 -0
  195. data/lib/fastly/models/sudo_response.rb +217 -0
  196. data/lib/fastly/models/values.rb +828 -0
  197. data/lib/fastly/version.rb +1 -1
  198. data/lib/fastly.rb +72 -2
  199. data/sig.json +1 -1
  200. metadata +146 -6
@@ -0,0 +1,184 @@
1
+ # Fastly::LegacyWafRuleApi
2
+
3
+
4
+ ```ruby
5
+ require 'fastly'
6
+ api_instance = Fastly::LegacyWafRuleApi.new
7
+ ```
8
+
9
+ ## Methods
10
+
11
+ | Method | HTTP request | Description |
12
+ | ------ | ------------ | ----------- |
13
+ | [**get_legacy_waf_firewall_rule_vcl**](LegacyWafRuleApi.md#get_legacy_waf_firewall_rule_vcl) | **GET** /wafs/{firewall_id}/rules/{waf_rule_id}/vcl | Get VCL for a rule associated with a firewall |
14
+ | [**get_legacy_waf_rule**](LegacyWafRuleApi.md#get_legacy_waf_rule) | **GET** /wafs/rules/{waf_rule_id} | Get a rule |
15
+ | [**get_legacy_waf_rule_vcl**](LegacyWafRuleApi.md#get_legacy_waf_rule_vcl) | **GET** /wafs/rules/{waf_rule_id}/vcl | Get VCL for a rule |
16
+ | [**list_legacy_waf_rules**](LegacyWafRuleApi.md#list_legacy_waf_rules) | **GET** /wafs/rules | List rules in the latest configuration set |
17
+
18
+
19
+ ## `get_legacy_waf_firewall_rule_vcl()`
20
+
21
+ ```ruby
22
+ get_legacy_waf_firewall_rule_vcl(opts): Object # Get VCL for a rule associated with a firewall
23
+ ```
24
+
25
+ Get associated VCL for a specific rule associated with a specific firewall.
26
+
27
+ ### Examples
28
+
29
+ ```ruby
30
+ api_instance = Fastly::LegacyWafRuleApi.new
31
+ opts = {
32
+ firewall_id: 'firewall_id_example', # String | Alphanumeric string identifying a Firewall.
33
+ waf_rule_id: 'waf_rule_id_example', # String | Alphanumeric string identifying a WAF rule.
34
+ }
35
+
36
+ begin
37
+ # Get VCL for a rule associated with a firewall
38
+ result = api_instance.get_legacy_waf_firewall_rule_vcl(opts)
39
+ p result
40
+ rescue Fastly::ApiError => e
41
+ puts "Error when calling LegacyWafRuleApi->get_legacy_waf_firewall_rule_vcl: #{e}"
42
+ end
43
+ ```
44
+
45
+ ### Options
46
+
47
+ | Name | Type | Description | Notes |
48
+ | ---- | ---- | ----------- | ----- |
49
+ | **firewall_id** | **String** | Alphanumeric string identifying a Firewall. | |
50
+ | **waf_rule_id** | **String** | Alphanumeric string identifying a WAF rule. | |
51
+
52
+ ### Return type
53
+
54
+ **Object**
55
+
56
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
57
+ [[Back to README]](../../README.md)
58
+ ## `get_legacy_waf_rule()`
59
+
60
+ ```ruby
61
+ get_legacy_waf_rule(opts): Object # Get a rule
62
+ ```
63
+
64
+ Get a specific rule.
65
+
66
+ ### Examples
67
+
68
+ ```ruby
69
+ api_instance = Fastly::LegacyWafRuleApi.new
70
+ opts = {
71
+ waf_rule_id: 'waf_rule_id_example', # String | Alphanumeric string identifying a WAF rule.
72
+ filter_configuration_set_id: 'filter_configuration_set_id_example', # String | Optional. Limit rule to a specific configuration set or pass \"all\" to search all configuration sets, including stale ones.
73
+ include: 'tags', # String | Include relationships. Optional. Comma separated values. Permitted values: `tags`, `rule_statuses`, `source`, and `vcl`.
74
+ }
75
+
76
+ begin
77
+ # Get a rule
78
+ result = api_instance.get_legacy_waf_rule(opts)
79
+ p result
80
+ rescue Fastly::ApiError => e
81
+ puts "Error when calling LegacyWafRuleApi->get_legacy_waf_rule: #{e}"
82
+ end
83
+ ```
84
+
85
+ ### Options
86
+
87
+ | Name | Type | Description | Notes |
88
+ | ---- | ---- | ----------- | ----- |
89
+ | **filter_configuration_set_id** | **String** | Optional. Limit rule to a specific configuration set or pass \"all\" to search all configuration sets, including stale ones. | [optional] |
90
+ | **include** | **String** | Include relationships. Optional. Comma separated values. Permitted values: `tags`, `rule_statuses`, `source`, and `vcl`. | [optional] |
91
+ | **waf_rule_id** | **String** | Alphanumeric string identifying a WAF rule. | |
92
+
93
+ ### Return type
94
+
95
+ **Object**
96
+
97
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
98
+ [[Back to README]](../../README.md)
99
+ ## `get_legacy_waf_rule_vcl()`
100
+
101
+ ```ruby
102
+ get_legacy_waf_rule_vcl(opts): Object # Get VCL for a rule
103
+ ```
104
+
105
+ Get associated VCL for a specific rule.
106
+
107
+ ### Examples
108
+
109
+ ```ruby
110
+ api_instance = Fastly::LegacyWafRuleApi.new
111
+ opts = {
112
+ waf_rule_id: 'waf_rule_id_example', # String | Alphanumeric string identifying a WAF rule.
113
+ }
114
+
115
+ begin
116
+ # Get VCL for a rule
117
+ result = api_instance.get_legacy_waf_rule_vcl(opts)
118
+ p result
119
+ rescue Fastly::ApiError => e
120
+ puts "Error when calling LegacyWafRuleApi->get_legacy_waf_rule_vcl: #{e}"
121
+ end
122
+ ```
123
+
124
+ ### Options
125
+
126
+ | Name | Type | Description | Notes |
127
+ | ---- | ---- | ----------- | ----- |
128
+ | **waf_rule_id** | **String** | Alphanumeric string identifying a WAF rule. | |
129
+
130
+ ### Return type
131
+
132
+ **Object**
133
+
134
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
135
+ [[Back to README]](../../README.md)
136
+ ## `list_legacy_waf_rules()`
137
+
138
+ ```ruby
139
+ list_legacy_waf_rules(opts): Array<Object> # List rules in the latest configuration set
140
+ ```
141
+
142
+ List all rules in the latest configuration set.
143
+
144
+ ### Examples
145
+
146
+ ```ruby
147
+ api_instance = Fastly::LegacyWafRuleApi.new
148
+ opts = {
149
+ filter_rule_id: 'filter_rule_id_example', # String | Limit the returned rules to a specific rule ID.
150
+ filter_severity: 'filter_severity_example', # String | Limit the returned rules to a specific severity.
151
+ filter_tags_name: 'filter_tags_name_example', # String | Limit the returned rules to a set linked to a tag by name.
152
+ filter_configuration_set_id: 'filter_configuration_set_id_example', # String | Optional. Limit rules to specific configuration set or pass \"all\" to search all configuration sets, including stale ones.
153
+ page_number: 1, # Integer | Current page.
154
+ page_size: 20, # Integer | Number of records per page.
155
+ include: 'include_example', # String | Include relationships. Optional. Comma separated values. Permitted values: `tags`, `rule_statuses`, and `source`.
156
+ }
157
+
158
+ begin
159
+ # List rules in the latest configuration set
160
+ result = api_instance.list_legacy_waf_rules(opts)
161
+ p result
162
+ rescue Fastly::ApiError => e
163
+ puts "Error when calling LegacyWafRuleApi->list_legacy_waf_rules: #{e}"
164
+ end
165
+ ```
166
+
167
+ ### Options
168
+
169
+ | Name | Type | Description | Notes |
170
+ | ---- | ---- | ----------- | ----- |
171
+ | **filter_rule_id** | **String** | Limit the returned rules to a specific rule ID. | [optional] |
172
+ | **filter_severity** | **String** | Limit the returned rules to a specific severity. | [optional] |
173
+ | **filter_tags_name** | **String** | Limit the returned rules to a set linked to a tag by name. | [optional] |
174
+ | **filter_configuration_set_id** | **String** | Optional. Limit rules to specific configuration set or pass \"all\" to search all configuration sets, including stale ones. | [optional] |
175
+ | **page_number** | **Integer** | Current page. | [optional] |
176
+ | **page_size** | **Integer** | Number of records per page. | [optional][default to 20] |
177
+ | **include** | **String** | Include relationships. Optional. Comma separated values. Permitted values: `tags`, `rule_statuses`, and `source`. | [optional] |
178
+
179
+ ### Return type
180
+
181
+ **Array<Object>**
182
+
183
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
184
+ [[Back to README]](../../README.md)
@@ -0,0 +1,12 @@
1
+ # Fastly::LegacyWafRuleStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | Describes the behavior for the particular rule within this firewall. Permitted values: `log`, `block`, and `disabled`. | [optional] |
8
+ | **modsec_rule_id** | **String** | The ModSecurity rule ID. | [optional] |
9
+ | **unique_rule_id** | **String** | The Rule ID. | [optional] |
10
+
11
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
12
+
@@ -0,0 +1,202 @@
1
+ # Fastly::LegacyWafRuleStatusApi
2
+
3
+
4
+ ```ruby
5
+ require 'fastly'
6
+ api_instance = Fastly::LegacyWafRuleStatusApi.new
7
+ ```
8
+
9
+ ## Methods
10
+
11
+ | Method | HTTP request | Description |
12
+ | ------ | ------------ | ----------- |
13
+ | [**get_waf_firewall_rule_status**](LegacyWafRuleStatusApi.md#get_waf_firewall_rule_status) | **GET** /service/{service_id}/wafs/{firewall_id}/rules/{waf_rule_id}/rule_status | Get the status of a rule on a firewall |
14
+ | [**list_waf_firewall_rule_statuses**](LegacyWafRuleStatusApi.md#list_waf_firewall_rule_statuses) | **GET** /service/{service_id}/wafs/{firewall_id}/rule_statuses | List rule statuses |
15
+ | [**update_waf_firewall_rule_status**](LegacyWafRuleStatusApi.md#update_waf_firewall_rule_status) | **PATCH** /service/{service_id}/wafs/{firewall_id}/rules/{waf_rule_id}/rule_status | Update the status of a rule |
16
+ | [**update_waf_firewall_rule_statuses_tag**](LegacyWafRuleStatusApi.md#update_waf_firewall_rule_statuses_tag) | **POST** /service/{service_id}/wafs/{firewall_id}/rule_statuses | Create or update status of a tagged group of rules |
17
+
18
+
19
+ ## `get_waf_firewall_rule_status()`
20
+
21
+ ```ruby
22
+ get_waf_firewall_rule_status(opts): Object # Get the status of a rule on a firewall
23
+ ```
24
+
25
+ Get a specific rule status object for a particular service, firewall, and rule.
26
+
27
+ ### Examples
28
+
29
+ ```ruby
30
+ api_instance = Fastly::LegacyWafRuleStatusApi.new
31
+ opts = {
32
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
33
+ firewall_id: 'firewall_id_example', # String | Alphanumeric string identifying a Firewall.
34
+ waf_rule_id: 'waf_rule_id_example', # String | Alphanumeric string identifying a WAF rule.
35
+ }
36
+
37
+ begin
38
+ # Get the status of a rule on a firewall
39
+ result = api_instance.get_waf_firewall_rule_status(opts)
40
+ p result
41
+ rescue Fastly::ApiError => e
42
+ puts "Error when calling LegacyWafRuleStatusApi->get_waf_firewall_rule_status: #{e}"
43
+ end
44
+ ```
45
+
46
+ ### Options
47
+
48
+ | Name | Type | Description | Notes |
49
+ | ---- | ---- | ----------- | ----- |
50
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
51
+ | **firewall_id** | **String** | Alphanumeric string identifying a Firewall. | |
52
+ | **waf_rule_id** | **String** | Alphanumeric string identifying a WAF rule. | |
53
+
54
+ ### Return type
55
+
56
+ **Object**
57
+
58
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
59
+ [[Back to README]](../../README.md)
60
+ ## `list_waf_firewall_rule_statuses()`
61
+
62
+ ```ruby
63
+ list_waf_firewall_rule_statuses(opts): Object # List rule statuses
64
+ ```
65
+
66
+ List all rule statuses for a particular service and firewall.
67
+
68
+ ### Examples
69
+
70
+ ```ruby
71
+ api_instance = Fastly::LegacyWafRuleStatusApi.new
72
+ opts = {
73
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
74
+ firewall_id: 'firewall_id_example', # String | Alphanumeric string identifying a Firewall.
75
+ filter_status: 'filter_status_example', # String | Limit results to rule statuses with the specified status.
76
+ filter_rule_message: 'filter_rule_message_example', # String | Limit results to rule statuses whose rules have the specified message.
77
+ filter_rule_rule_id: 'filter_rule_rule_id_example', # String | Limit results to rule statuses whose rules represent the specified ModSecurity rule_id.
78
+ filter_rule_tags: 'filter_rule_tags_example', # String | Limit results to rule statuses whose rules relate to the specified tag IDs.
79
+ filter_rule_tags_name: 'application-FBC Market', # String | Limit results to rule statuses whose rules related to the named tags.
80
+ include: 'include_example', # String | Include relationships. Optional, comma separated values. Permitted values: `tags`.
81
+ page_number: 1, # Integer | Current page.
82
+ page_size: 20, # Integer | Number of records per page.
83
+ }
84
+
85
+ begin
86
+ # List rule statuses
87
+ result = api_instance.list_waf_firewall_rule_statuses(opts)
88
+ p result
89
+ rescue Fastly::ApiError => e
90
+ puts "Error when calling LegacyWafRuleStatusApi->list_waf_firewall_rule_statuses: #{e}"
91
+ end
92
+ ```
93
+
94
+ ### Options
95
+
96
+ | Name | Type | Description | Notes |
97
+ | ---- | ---- | ----------- | ----- |
98
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
99
+ | **firewall_id** | **String** | Alphanumeric string identifying a Firewall. | |
100
+ | **filter_status** | **String** | Limit results to rule statuses with the specified status. | [optional] |
101
+ | **filter_rule_message** | **String** | Limit results to rule statuses whose rules have the specified message. | [optional] |
102
+ | **filter_rule_rule_id** | **String** | Limit results to rule statuses whose rules represent the specified ModSecurity rule_id. | [optional] |
103
+ | **filter_rule_tags** | **String** | Limit results to rule statuses whose rules relate to the specified tag IDs. | [optional] |
104
+ | **filter_rule_tags_name** | **String** | Limit results to rule statuses whose rules related to the named tags. | [optional] |
105
+ | **include** | **String** | Include relationships. Optional, comma separated values. Permitted values: `tags`. | [optional] |
106
+ | **page_number** | **Integer** | Current page. | [optional] |
107
+ | **page_size** | **Integer** | Number of records per page. | [optional][default to 20] |
108
+
109
+ ### Return type
110
+
111
+ **Object**
112
+
113
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
114
+ [[Back to README]](../../README.md)
115
+ ## `update_waf_firewall_rule_status()`
116
+
117
+ ```ruby
118
+ update_waf_firewall_rule_status(opts): Object # Update the status of a rule
119
+ ```
120
+
121
+ Update a rule status for a particular service, firewall, and rule.
122
+
123
+ ### Examples
124
+
125
+ ```ruby
126
+ api_instance = Fastly::LegacyWafRuleStatusApi.new
127
+ opts = {
128
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
129
+ firewall_id: 'firewall_id_example', # String | Alphanumeric string identifying a Firewall.
130
+ waf_rule_id: 'waf_rule_id_example', # String | Alphanumeric string identifying a WAF rule.
131
+ request_body: { key: 3.56}, # Hash<String, Object> |
132
+ }
133
+
134
+ begin
135
+ # Update the status of a rule
136
+ result = api_instance.update_waf_firewall_rule_status(opts)
137
+ p result
138
+ rescue Fastly::ApiError => e
139
+ puts "Error when calling LegacyWafRuleStatusApi->update_waf_firewall_rule_status: #{e}"
140
+ end
141
+ ```
142
+
143
+ ### Options
144
+
145
+ | Name | Type | Description | Notes |
146
+ | ---- | ---- | ----------- | ----- |
147
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
148
+ | **firewall_id** | **String** | Alphanumeric string identifying a Firewall. | |
149
+ | **waf_rule_id** | **String** | Alphanumeric string identifying a WAF rule. | |
150
+ | **request_body** | [**Hash&lt;String, Object&gt;**](Object.md) | | [optional] |
151
+
152
+ ### Return type
153
+
154
+ **Object**
155
+
156
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
157
+ [[Back to README]](../../README.md)
158
+ ## `update_waf_firewall_rule_statuses_tag()`
159
+
160
+ ```ruby
161
+ update_waf_firewall_rule_statuses_tag(opts): Object # Create or update status of a tagged group of rules
162
+ ```
163
+
164
+ Create or update all rule statuses for a particular service and firewall, based on tag name. By default, only rule status for enabled rules (with status log or block) will be updated. To update rule statuses for disabled rules under the specified tag, use the force attribute.
165
+
166
+ ### Examples
167
+
168
+ ```ruby
169
+ api_instance = Fastly::LegacyWafRuleStatusApi.new
170
+ opts = {
171
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
172
+ firewall_id: 'firewall_id_example', # String | Alphanumeric string identifying a Firewall.
173
+ name: 'name_example', # String | The tag name to use to determine the set of rules to update. For example, OWASP or language-php.
174
+ force: 'force_example', # String | Whether or not to update rule statuses for disabled rules. Optional.
175
+ request_body: { key: 3.56}, # Hash<String, Object> |
176
+ }
177
+
178
+ begin
179
+ # Create or update status of a tagged group of rules
180
+ result = api_instance.update_waf_firewall_rule_statuses_tag(opts)
181
+ p result
182
+ rescue Fastly::ApiError => e
183
+ puts "Error when calling LegacyWafRuleStatusApi->update_waf_firewall_rule_statuses_tag: #{e}"
184
+ end
185
+ ```
186
+
187
+ ### Options
188
+
189
+ | Name | Type | Description | Notes |
190
+ | ---- | ---- | ----------- | ----- |
191
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
192
+ | **firewall_id** | **String** | Alphanumeric string identifying a Firewall. | |
193
+ | **name** | **String** | The tag name to use to determine the set of rules to update. For example, OWASP or language-php. | [optional] |
194
+ | **force** | **String** | Whether or not to update rule statuses for disabled rules. Optional. | [optional] |
195
+ | **request_body** | [**Hash&lt;String, Object&gt;**](Object.md) | | [optional] |
196
+
197
+ ### Return type
198
+
199
+ **Object**
200
+
201
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
202
+ [[Back to README]](../../README.md)
@@ -0,0 +1,11 @@
1
+ # Fastly::LegacyWafRuleset
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **last_push** | **String** | Date and time WAF ruleset VCL was last deployed. | [optional] |
8
+ | **vcl** | **String** | The WAF ruleset VCL currently deployed. | [optional] |
9
+
10
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
11
+
@@ -0,0 +1,136 @@
1
+ # Fastly::LegacyWafRulesetApi
2
+
3
+
4
+ ```ruby
5
+ require 'fastly'
6
+ api_instance = Fastly::LegacyWafRulesetApi.new
7
+ ```
8
+
9
+ ## Methods
10
+
11
+ | Method | HTTP request | Description |
12
+ | ------ | ------------ | ----------- |
13
+ | [**get_waf_ruleset**](LegacyWafRulesetApi.md#get_waf_ruleset) | **GET** /service/{service_id}/wafs/{firewall_id}/ruleset | Get a WAF ruleset |
14
+ | [**get_waf_ruleset_vcl**](LegacyWafRulesetApi.md#get_waf_ruleset_vcl) | **GET** /service/{service_id}/wafs/{firewall_id}/ruleset/preview | Generate WAF ruleset VCL |
15
+ | [**update_waf_ruleset**](LegacyWafRulesetApi.md#update_waf_ruleset) | **PATCH** /service/{service_id}/wafs/{firewall_id}/ruleset | Update a WAF ruleset |
16
+
17
+
18
+ ## `get_waf_ruleset()`
19
+
20
+ ```ruby
21
+ get_waf_ruleset(opts): Object # Get a WAF ruleset
22
+ ```
23
+
24
+ Get a WAF ruleset for a particular service and firewall object.
25
+
26
+ ### Examples
27
+
28
+ ```ruby
29
+ api_instance = Fastly::LegacyWafRulesetApi.new
30
+ opts = {
31
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
32
+ firewall_id: 'firewall_id_example', # String | Alphanumeric string identifying a Firewall.
33
+ }
34
+
35
+ begin
36
+ # Get a WAF ruleset
37
+ result = api_instance.get_waf_ruleset(opts)
38
+ p result
39
+ rescue Fastly::ApiError => e
40
+ puts "Error when calling LegacyWafRulesetApi->get_waf_ruleset: #{e}"
41
+ end
42
+ ```
43
+
44
+ ### Options
45
+
46
+ | Name | Type | Description | Notes |
47
+ | ---- | ---- | ----------- | ----- |
48
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
49
+ | **firewall_id** | **String** | Alphanumeric string identifying a Firewall. | |
50
+
51
+ ### Return type
52
+
53
+ **Object**
54
+
55
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
56
+ [[Back to README]](../../README.md)
57
+ ## `get_waf_ruleset_vcl()`
58
+
59
+ ```ruby
60
+ get_waf_ruleset_vcl(opts): Object # Generate WAF ruleset VCL
61
+ ```
62
+
63
+ Get a preview of the WAF ruleset VCL for a particular service and firewall object based on changes to WAF configuration before deploying the ruleset. The response will include a link to status of the background VCL generation job. Once the background job is completed, the preview WAF ruleset VCL can be retrieved from the status response.
64
+
65
+ ### Examples
66
+
67
+ ```ruby
68
+ api_instance = Fastly::LegacyWafRulesetApi.new
69
+ opts = {
70
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
71
+ firewall_id: 'firewall_id_example', # String | Alphanumeric string identifying a Firewall.
72
+ }
73
+
74
+ begin
75
+ # Generate WAF ruleset VCL
76
+ result = api_instance.get_waf_ruleset_vcl(opts)
77
+ p result
78
+ rescue Fastly::ApiError => e
79
+ puts "Error when calling LegacyWafRulesetApi->get_waf_ruleset_vcl: #{e}"
80
+ end
81
+ ```
82
+
83
+ ### Options
84
+
85
+ | Name | Type | Description | Notes |
86
+ | ---- | ---- | ----------- | ----- |
87
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
88
+ | **firewall_id** | **String** | Alphanumeric string identifying a Firewall. | |
89
+
90
+ ### Return type
91
+
92
+ **Object**
93
+
94
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
95
+ [[Back to README]](../../README.md)
96
+ ## `update_waf_ruleset()`
97
+
98
+ ```ruby
99
+ update_waf_ruleset(opts): Object # Update a WAF ruleset
100
+ ```
101
+
102
+ Update the WAF ruleset for a particular service and firewall object. Use the URL in the response to view the WAF ruleset deploy status.
103
+
104
+ ### Examples
105
+
106
+ ```ruby
107
+ api_instance = Fastly::LegacyWafRulesetApi.new
108
+ opts = {
109
+ service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
110
+ firewall_id: 'firewall_id_example', # String | Alphanumeric string identifying a Firewall.
111
+ request_body: { key: 3.56}, # Hash<String, Object> |
112
+ }
113
+
114
+ begin
115
+ # Update a WAF ruleset
116
+ result = api_instance.update_waf_ruleset(opts)
117
+ p result
118
+ rescue Fastly::ApiError => e
119
+ puts "Error when calling LegacyWafRulesetApi->update_waf_ruleset: #{e}"
120
+ end
121
+ ```
122
+
123
+ ### Options
124
+
125
+ | Name | Type | Description | Notes |
126
+ | ---- | ---- | ----------- | ----- |
127
+ | **service_id** | **String** | Alphanumeric string identifying the service. | |
128
+ | **firewall_id** | **String** | Alphanumeric string identifying a Firewall. | |
129
+ | **request_body** | [**Hash&lt;String, Object&gt;**](Object.md) | | [optional] |
130
+
131
+ ### Return type
132
+
133
+ **Object**
134
+
135
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
136
+ [[Back to README]](../../README.md)
@@ -0,0 +1,10 @@
1
+ # Fastly::LegacyWafTag
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Name of the tag. | [optional] |
8
+
9
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10
+
@@ -0,0 +1,58 @@
1
+ # Fastly::LegacyWafTagApi
2
+
3
+
4
+ ```ruby
5
+ require 'fastly'
6
+ api_instance = Fastly::LegacyWafTagApi.new
7
+ ```
8
+
9
+ ## Methods
10
+
11
+ | Method | HTTP request | Description |
12
+ | ------ | ------------ | ----------- |
13
+ | [**list_legacy_waf_tags**](LegacyWafTagApi.md#list_legacy_waf_tags) | **GET** /wafs/tags | List WAF tags |
14
+
15
+
16
+ ## `list_legacy_waf_tags()`
17
+
18
+ ```ruby
19
+ list_legacy_waf_tags(opts): Object # List WAF tags
20
+ ```
21
+
22
+ List all tags.
23
+
24
+ ### Examples
25
+
26
+ ```ruby
27
+ api_instance = Fastly::LegacyWafTagApi.new
28
+ opts = {
29
+ filter_name: 'filter_name_example', # String | Limit the returned tags to a specific name.
30
+ page_number: 1, # Integer | Current page.
31
+ page_size: 20, # Integer | Number of records per page.
32
+ include: 'rules', # String | Include relationships. Optional, comma separated values. Permitted values: `rules`.
33
+ }
34
+
35
+ begin
36
+ # List WAF tags
37
+ result = api_instance.list_legacy_waf_tags(opts)
38
+ p result
39
+ rescue Fastly::ApiError => e
40
+ puts "Error when calling LegacyWafTagApi->list_legacy_waf_tags: #{e}"
41
+ end
42
+ ```
43
+
44
+ ### Options
45
+
46
+ | Name | Type | Description | Notes |
47
+ | ---- | ---- | ----------- | ----- |
48
+ | **filter_name** | **String** | Limit the returned tags to a specific name. | [optional] |
49
+ | **page_number** | **Integer** | Current page. | [optional] |
50
+ | **page_size** | **Integer** | Number of records per page. | [optional][default to 20] |
51
+ | **include** | **String** | Include relationships. Optional, comma separated values. Permitted values: `rules`. | [optional] |
52
+
53
+ ### Return type
54
+
55
+ **Object**
56
+
57
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
58
+ [[Back to README]](../../README.md)
@@ -0,0 +1,15 @@
1
+ # Fastly::LegacyWafUpdateStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **completed_at** | **String** | Date and time that job was completed. | [optional] |
8
+ | **created_at** | **String** | Date and time that job was created. | [optional] |
9
+ | **data** | **String** | This field can contain data passed to the background worker as well as output from the background job. | [optional] |
10
+ | **message** | **String** | Message with information about the status of the update. | [optional] |
11
+ | **status** | **String** | Current status of the update. | [optional] |
12
+ | **updated_at** | **String** | Date and time that job was last updated. | [optional] |
13
+
14
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
15
+