Class: Fastly::LegacyWafRuleStatusApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/legacy_waf_rule_status_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LegacyWafRuleStatusApi

Returns a new instance of LegacyWafRuleStatusApi.



17
18
19
 
# File 'lib/fastly/api/legacy_waf_rule_status_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/legacy_waf_rule_status_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#get_waf_firewall_rule_status(opts = {}) ⇒ Object

Get the status of a rule on a firewall Get a specific rule status object for a particular service, firewall, and rule.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :firewall_id (String) —

    Alphanumeric string identifying a Firewall. (required)

  • :waf_rule_id (String) —

    Alphanumeric string identifying a WAF rule. (required)

Returns:

  • (Object) 


26
27
28
29
 
# File 'lib/fastly/api/legacy_waf_rule_status_api.rb', line 26

def get_waf_firewall_rule_status(opts = {})
  data, _status_code, _headers = get_waf_firewall_rule_status_with_http_info(opts)
  data
end

#get_waf_firewall_rule_status_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get the status of a rule on a firewall Get a specific rule status object for a particular service, firewall, and rule.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :firewall_id (String) —

    Alphanumeric string identifying a Firewall. (required)

  • :waf_rule_id (String) —

    Alphanumeric string identifying a WAF rule. (required)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/fastly/api/legacy_waf_rule_status_api.rb', line 37

def get_waf_firewall_rule_status_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LegacyWafRuleStatusApi.get_waf_firewall_rule_status ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  firewall_id = opts[:'firewall_id']
  waf_rule_id = opts[:'waf_rule_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LegacyWafRuleStatusApi.get_waf_firewall_rule_status"
  end
  # verify the required parameter 'firewall_id' is set
  if @api_client.config.client_side_validation && firewall_id.nil?
    fail ArgumentError, "Missing the required parameter 'firewall_id' when calling LegacyWafRuleStatusApi.get_waf_firewall_rule_status"
  end
  # verify the required parameter 'waf_rule_id' is set
  if @api_client.config.client_side_validation && waf_rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'waf_rule_id' when calling LegacyWafRuleStatusApi.get_waf_firewall_rule_status"
  end
  # resource path
  local_var_path = '/service/{service_id}/wafs/{firewall_id}/rules/{waf_rule_id}/rule_status'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'firewall_id' + '}', CGI.escape(firewall_id.to_s)).sub('{' + 'waf_rule_id' + '}', CGI.escape(waf_rule_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LegacyWafRuleStatusApi.get_waf_firewall_rule_status",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LegacyWafRuleStatusApi#get_waf_firewall_rule_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_waf_firewall_rule_statuses(opts = {}) ⇒ Object

List rule statuses List all rule statuses for a particular service and firewall.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :firewall_id (String) —

    Alphanumeric string identifying a Firewall. (required)

  • :filter_status (String) —

    Limit results to rule statuses with the specified status.

  • :filter_rule_message (String) —

    Limit results to rule statuses whose rules have the specified message.

  • :filter_rule_rule_id (String) —

    Limit results to rule statuses whose rules represent the specified ModSecurity rule_id.

  • :filter_rule_tags (String) —

    Limit results to rule statuses whose rules relate to the specified tag IDs.

  • :filter_rule_tags_name (String) —

    Limit results to rule statuses whose rules related to the named tags.

  • :include (String) —

    Include relationships. Optional, comma separated values. Permitted values: &#x60;tags&#x60;.

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

Returns:

  • (Object) 


110
111
112
113
 
# File 'lib/fastly/api/legacy_waf_rule_status_api.rb', line 110

def list_waf_firewall_rule_statuses(opts = {})
  data, _status_code, _headers = list_waf_firewall_rule_statuses_with_http_info(opts)
  data
end

#list_waf_firewall_rule_statuses_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

List rule statuses List all rule statuses for a particular service and firewall.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :firewall_id (String) —

    Alphanumeric string identifying a Firewall. (required)

  • :filter_status (String) —

    Limit results to rule statuses with the specified status.

  • :filter_rule_message (String) —

    Limit results to rule statuses whose rules have the specified message.

  • :filter_rule_rule_id (String) —

    Limit results to rule statuses whose rules represent the specified ModSecurity rule_id.

  • :filter_rule_tags (String) —

    Limit results to rule statuses whose rules relate to the specified tag IDs.

  • :filter_rule_tags_name (String) —

    Limit results to rule statuses whose rules related to the named tags.

  • :include (String) —

    Include relationships. Optional, comma separated values. Permitted values: &#x60;tags&#x60;.

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/fastly/api/legacy_waf_rule_status_api.rb', line 128

def list_waf_firewall_rule_statuses_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LegacyWafRuleStatusApi.list_waf_firewall_rule_statuses ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  firewall_id = opts[:'firewall_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LegacyWafRuleStatusApi.list_waf_firewall_rule_statuses"
  end
  # verify the required parameter 'firewall_id' is set
  if @api_client.config.client_side_validation && firewall_id.nil?
    fail ArgumentError, "Missing the required parameter 'firewall_id' when calling LegacyWafRuleStatusApi.list_waf_firewall_rule_statuses"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling LegacyWafRuleStatusApi.list_waf_firewall_rule_statuses, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling LegacyWafRuleStatusApi.list_waf_firewall_rule_statuses, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/service/{service_id}/wafs/{firewall_id}/rule_statuses'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'firewall_id' + '}', CGI.escape(firewall_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[status]'] = opts[:'filter_status'] if !opts[:'filter_status'].nil?
  query_params[:'filter[rule][message]'] = opts[:'filter_rule_message'] if !opts[:'filter_rule_message'].nil?
  query_params[:'filter[rule][rule_id]'] = opts[:'filter_rule_rule_id'] if !opts[:'filter_rule_rule_id'].nil?
  query_params[:'filter[rule][tags]'] = opts[:'filter_rule_tags'] if !opts[:'filter_rule_tags'].nil?
  query_params[:'filter[rule][tags][name]'] = opts[:'filter_rule_tags_name'] if !opts[:'filter_rule_tags_name'].nil?
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LegacyWafRuleStatusApi.list_waf_firewall_rule_statuses",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LegacyWafRuleStatusApi#list_waf_firewall_rule_statuses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_waf_firewall_rule_status(opts = {}) ⇒ Object

Update the status of a rule Update a rule status for a particular service, firewall, and rule.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :firewall_id (String) —

    Alphanumeric string identifying a Firewall. (required)

  • :waf_rule_id (String) —

    Alphanumeric string identifying a WAF rule. (required)

  • :request_body (Hash<String, Object>)

Returns:

  • (Object) 


206
207
208
209
 
# File 'lib/fastly/api/legacy_waf_rule_status_api.rb', line 206

def update_waf_firewall_rule_status(opts = {})
  data, _status_code, _headers = update_waf_firewall_rule_status_with_http_info(opts)
  data
end

#update_waf_firewall_rule_status_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Update the status of a rule Update a rule status for a particular service, firewall, and rule.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :firewall_id (String) —

    Alphanumeric string identifying a Firewall. (required)

  • :waf_rule_id (String) —

    Alphanumeric string identifying a WAF rule. (required)

  • :request_body (Hash<String, Object>)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/fastly/api/legacy_waf_rule_status_api.rb', line 218

def update_waf_firewall_rule_status_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LegacyWafRuleStatusApi.update_waf_firewall_rule_status ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  firewall_id = opts[:'firewall_id']
  waf_rule_id = opts[:'waf_rule_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LegacyWafRuleStatusApi.update_waf_firewall_rule_status"
  end
  # verify the required parameter 'firewall_id' is set
  if @api_client.config.client_side_validation && firewall_id.nil?
    fail ArgumentError, "Missing the required parameter 'firewall_id' when calling LegacyWafRuleStatusApi.update_waf_firewall_rule_status"
  end
  # verify the required parameter 'waf_rule_id' is set
  if @api_client.config.client_side_validation && waf_rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'waf_rule_id' when calling LegacyWafRuleStatusApi.update_waf_firewall_rule_status"
  end
  # resource path
  local_var_path = '/service/{service_id}/wafs/{firewall_id}/rules/{waf_rule_id}/rule_status'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'firewall_id' + '}', CGI.escape(firewall_id.to_s)).sub('{' + 'waf_rule_id' + '}', CGI.escape(waf_rule_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'request_body'])

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LegacyWafRuleStatusApi.update_waf_firewall_rule_status",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LegacyWafRuleStatusApi#update_waf_firewall_rule_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_waf_firewall_rule_statuses_tag(opts = {}) ⇒ Object

Create or update status of a tagged group of rules 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.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :firewall_id (String) —

    Alphanumeric string identifying a Firewall. (required)

  • :name (String) —

    The tag name to use to determine the set of rules to update. For example, OWASP or language-php.

  • :force (String) —

    Whether or not to update rule statuses for disabled rules. Optional.

  • :request_body (Hash<String, Object>)

Returns:

  • (Object) 


291
292
293
294
 
# File 'lib/fastly/api/legacy_waf_rule_status_api.rb', line 291

def update_waf_firewall_rule_statuses_tag(opts = {})
  data, _status_code, _headers = update_waf_firewall_rule_statuses_tag_with_http_info(opts)
  data
end

#update_waf_firewall_rule_statuses_tag_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Create or update status of a tagged group of rules 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.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :firewall_id (String) —

    Alphanumeric string identifying a Firewall. (required)

  • :name (String) —

    The tag name to use to determine the set of rules to update. For example, OWASP or language-php.

  • :force (String) —

    Whether or not to update rule statuses for disabled rules. Optional.

  • :request_body (Hash<String, Object>)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/fastly/api/legacy_waf_rule_status_api.rb', line 304

def update_waf_firewall_rule_statuses_tag_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LegacyWafRuleStatusApi.update_waf_firewall_rule_statuses_tag ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  firewall_id = opts[:'firewall_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LegacyWafRuleStatusApi.update_waf_firewall_rule_statuses_tag"
  end
  # verify the required parameter 'firewall_id' is set
  if @api_client.config.client_side_validation && firewall_id.nil?
    fail ArgumentError, "Missing the required parameter 'firewall_id' when calling LegacyWafRuleStatusApi.update_waf_firewall_rule_statuses_tag"
  end
  # resource path
  local_var_path = '/service/{service_id}/wafs/{firewall_id}/rule_statuses'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'firewall_id' + '}', CGI.escape(firewall_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'force'] = opts[:'force'] if !opts[:'force'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'request_body'])

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LegacyWafRuleStatusApi.update_waf_firewall_rule_statuses_tag",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LegacyWafRuleStatusApi#update_waf_firewall_rule_statuses_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end