Class: Falcon::CorrelationRules

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/correlation_rules.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CorrelationRules

Returns a new instance of CorrelationRules.



36
37
38
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 36

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#aggregates_rule_versions_post_v1(ids, body, opts = {}) ⇒ ApiAggregatesResponseV1

Get rules aggregates as specified via json in the request body.

Parameters:

  • ids (Array<String>) —

    The IDs

  • body (Array<Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL query specifying the filter parameters

Returns:



45
46
47
48
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 45

def aggregates_rule_versions_post_v1(ids, body, opts = {})
  data, _status_code, _headers = aggregates_rule_versions_post_v1_with_http_info(ids, body, opts)
  data
end

#aggregates_rule_versions_post_v1_with_http_info(ids, body, opts = {}) ⇒ Array<(ApiAggregatesResponseV1, Integer, Hash)>

Get rules aggregates as specified via json in the request body.

Parameters:

  • ids (Array<String>) —

    The IDs

  • body (Array<Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL query specifying the filter parameters

Returns:

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

    ApiAggregatesResponseV1 data, response status code and response headers



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 56

def aggregates_rule_versions_post_v1_with_http_info(ids, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CorrelationRules.aggregates_rule_versions_post_v1 ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling CorrelationRules.aggregates_rule_versions_post_v1"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CorrelationRules.aggregates_rule_versions_post_v1"
  end
  # resource path
  local_var_path = '/correlation-rules/aggregates/rule-versions/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/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(body)

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

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

  new_options = opts.merge(
    :operation => :"CorrelationRules.aggregates_rule_versions_post_v1",
    :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: CorrelationRules#aggregates_rule_versions_post_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#combined_rules_get_v1(opts = {}) ⇒ ApiGetEntitiesRulesResponseV1

Find all rules matching the query and filter. Supported filters: customer_id,user_id,user_uuid,status,name,created_on,last_updated_on Supported range filters: created_on,last_updated_on

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL query specifying the filter parameters

  • :q (String) —

    Match query criteria, which includes all the filter string fields

  • :sort (String) —

    Rule property to sort on (default to ‘created_on’)

  • :offset (Integer) —

    Starting index of overall result set from which to return IDs (default to 0)

  • :limit (Integer) —

    Number of IDs to return (default to 100)

Returns:



123
124
125
126
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 123

def combined_rules_get_v1(opts = {})
  data, _status_code, _headers = combined_rules_get_v1_with_http_info(opts)
  data
end

#combined_rules_get_v1_with_http_info(opts = {}) ⇒ Array<(ApiGetEntitiesRulesResponseV1, Integer, Hash)>

Find all rules matching the query and filter. Supported filters: customer_id,user_id,user_uuid,status,name,created_on,last_updated_on Supported range filters: created_on,last_updated_on

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL query specifying the filter parameters

  • :q (String) —

    Match query criteria, which includes all the filter string fields

  • :sort (String) —

    Rule property to sort on (default to ‘created_on’)

  • :offset (Integer) —

    Starting index of overall result set from which to return IDs (default to 0)

  • :limit (Integer) —

    Number of IDs to return (default to 100)

Returns:



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
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 136

def combined_rules_get_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CorrelationRules.combined_rules_get_v1 ...'
  end
  allowable_values = ["created_on", "created_on|desc", "last_updated_on", "last_updated_on|desc"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/correlation-rules/combined/rules/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"CorrelationRules.combined_rules_get_v1",
    :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: CorrelationRules#combined_rules_get_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#combined_rules_get_v2(opts = {}) ⇒ ApiGetEntitiesRulesResponseV1

Find all rules matching the query and filter. Supported filters: customer_id,user_id,user_uuid,status,name,created_on,last_updated_on Supported range filters: created_on,last_updated_on

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL query specifying the filter parameters

  • :q (String) —

    Match query criteria, which includes all the filter string fields

  • :sort (String) —

    Rule property to sort on (default to ‘created_on’)

  • :offset (Integer) —

    Starting index of overall result set from which to return IDs (default to 0)

  • :limit (Integer) —

    Number of IDs to return (default to 100)

Returns:



197
198
199
200
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 197

def combined_rules_get_v2(opts = {})
  data, _status_code, _headers = combined_rules_get_v2_with_http_info(opts)
  data
end

#combined_rules_get_v2_with_http_info(opts = {}) ⇒ Array<(ApiGetEntitiesRulesResponseV1, Integer, Hash)>

Find all rules matching the query and filter. Supported filters: customer_id,user_id,user_uuid,status,name,created_on,last_updated_on Supported range filters: created_on,last_updated_on

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL query specifying the filter parameters

  • :q (String) —

    Match query criteria, which includes all the filter string fields

  • :sort (String) —

    Rule property to sort on (default to ‘created_on’)

  • :offset (Integer) —

    Starting index of overall result set from which to return IDs (default to 0)

  • :limit (Integer) —

    Number of IDs to return (default to 100)

Returns:



210
211
212
213
214
215
216
217
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
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 210

def combined_rules_get_v2_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CorrelationRules.combined_rules_get_v2 ...'
  end
  allowable_values = ["created_on", "created_on|desc", "last_updated_on", "last_updated_on|desc"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/correlation-rules/combined/rules/v2'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"CorrelationRules.combined_rules_get_v2",
    :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: CorrelationRules#combined_rules_get_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entities_latest_rules_get_v1(rule_ids, opts = {}) ⇒ ApiGetEntitiesRulesResponseV1

Retrieve latest rule versions by rule IDs

Parameters:

  • rule_ids (Array<String>) —

    The rule IDs

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

    the optional parameters

Returns:



267
268
269
270
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 267

def entities_latest_rules_get_v1(rule_ids, opts = {})
  data, _status_code, _headers = entities_latest_rules_get_v1_with_http_info(rule_ids, opts)
  data
end

#entities_latest_rules_get_v1_with_http_info(rule_ids, opts = {}) ⇒ Array<(ApiGetEntitiesRulesResponseV1, Integer, Hash)>

Retrieve latest rule versions by rule IDs

Parameters:

  • rule_ids (Array<String>) —

    The rule IDs

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

    the optional parameters

Returns:



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 276

def entities_latest_rules_get_v1_with_http_info(rule_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CorrelationRules.entities_latest_rules_get_v1 ...'
  end
  # verify the required parameter 'rule_ids' is set
  if @api_client.config.client_side_validation && rule_ids.nil?
    fail ArgumentError, "Missing the required parameter 'rule_ids' when calling CorrelationRules.entities_latest_rules_get_v1"
  end
  # resource path
  local_var_path = '/correlation-rules/entities/latest-rules/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'rule_ids'] = @api_client.build_collection_param(rule_ids, :multi)

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"CorrelationRules.entities_latest_rules_get_v1",
    :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: CorrelationRules#entities_latest_rules_get_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entities_rule_versions_delete_v1(ids, opts = {}) ⇒ MsaspecQueryResponse

Delete versions by IDs

Parameters:

  • ids (Array<String>) —

    The IDs

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

    the optional parameters

Returns:



329
330
331
332
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 329

def entities_rule_versions_delete_v1(ids, opts = {})
  data, _status_code, _headers = entities_rule_versions_delete_v1_with_http_info(ids, opts)
  data
end

#entities_rule_versions_delete_v1_with_http_info(ids, opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>

Delete versions by IDs

Parameters:

  • ids (Array<String>) —

    The IDs

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

    the optional parameters

Returns:

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

    MsaspecQueryResponse data, response status code and response headers



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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 338

def entities_rule_versions_delete_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CorrelationRules.entities_rule_versions_delete_v1 ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling CorrelationRules.entities_rule_versions_delete_v1"
  end
  # resource path
  local_var_path = '/correlation-rules/entities/rule-versions/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"CorrelationRules.entities_rule_versions_delete_v1",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorrelationRules#entities_rule_versions_delete_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entities_rule_versions_export_post_v1(body, opts = {}) ⇒ ApiJobLinkResponseV1

Export rule versions

Parameters:

Returns:



391
392
393
394
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 391

def entities_rule_versions_export_post_v1(body, opts = {})
  data, _status_code, _headers = entities_rule_versions_export_post_v1_with_http_info(body, opts)
  data
end

#entities_rule_versions_export_post_v1_with_http_info(body, opts = {}) ⇒ Array<(ApiJobLinkResponseV1, Integer, Hash)>

Export rule versions

Parameters:

Returns:

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

    ApiJobLinkResponseV1 data, response status code and response headers



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 400

def entities_rule_versions_export_post_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CorrelationRules.entities_rule_versions_export_post_v1 ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CorrelationRules.entities_rule_versions_export_post_v1"
  end
  # resource path
  local_var_path = '/correlation-rules/entities/rule-versions/export/v1'

  # 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/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/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(body)

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

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

  new_options = opts.merge(
    :operation => :"CorrelationRules.entities_rule_versions_export_post_v1",
    :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: CorrelationRules#entities_rule_versions_export_post_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entities_rule_versions_import_post_v1(opts = {}) ⇒ ApiGetEntitiesRuleVersionsResponseV1

Import rule versions

Parameters:

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

    the optional parameters

Returns:



456
457
458
459
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 456

def entities_rule_versions_import_post_v1(opts = {})
  data, _status_code, _headers = entities_rule_versions_import_post_v1_with_http_info(opts)
  data
end

#entities_rule_versions_import_post_v1_with_http_info(opts = {}) ⇒ Array<(ApiGetEntitiesRuleVersionsResponseV1, Integer, Hash)>

Import rule versions

Parameters:

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

    the optional parameters

Returns:



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 464

def entities_rule_versions_import_post_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CorrelationRules.entities_rule_versions_import_post_v1 ...'
  end
  # resource path
  local_var_path = '/correlation-rules/entities/rule-versions/import/v1'

  # 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/json'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"CorrelationRules.entities_rule_versions_import_post_v1",
    :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: CorrelationRules#entities_rule_versions_import_post_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entities_rule_versions_publish_patch_v1(body, opts = {}) ⇒ ApiGetEntitiesRuleVersionsResponseV1

Publish existing rule version

Parameters:

Returns:



512
513
514
515
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 512

def entities_rule_versions_publish_patch_v1(body, opts = {})
  data, _status_code, _headers = entities_rule_versions_publish_patch_v1_with_http_info(body, opts)
  data
end

#entities_rule_versions_publish_patch_v1_with_http_info(body, opts = {}) ⇒ Array<(ApiGetEntitiesRuleVersionsResponseV1, Integer, Hash)>

Publish existing rule version

Parameters:

Returns:



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 521

def entities_rule_versions_publish_patch_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CorrelationRules.entities_rule_versions_publish_patch_v1 ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CorrelationRules.entities_rule_versions_publish_patch_v1"
  end
  # resource path
  local_var_path = '/correlation-rules/entities/rule-versions/publish/v1'

  # 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/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/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(body)

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

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

  new_options = opts.merge(
    :operation => :"CorrelationRules.entities_rule_versions_publish_patch_v1",
    :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: CorrelationRules#entities_rule_versions_publish_patch_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entities_rules_delete_v1(ids, opts = {}) ⇒ MsaspecQueryResponse

Delete rules by IDs

Parameters:

  • ids (Array<String>) —

    The IDs

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

    the optional parameters

Returns:



578
579
580
581
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 578

def entities_rules_delete_v1(ids, opts = {})
  data, _status_code, _headers = entities_rules_delete_v1_with_http_info(ids, opts)
  data
end

#entities_rules_delete_v1_with_http_info(ids, opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>

Delete rules by IDs

Parameters:

  • ids (Array<String>) —

    The IDs

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

    the optional parameters

Returns:

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

    MsaspecQueryResponse data, response status code and response headers



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 587

def entities_rules_delete_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CorrelationRules.entities_rules_delete_v1 ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling CorrelationRules.entities_rules_delete_v1"
  end
  # resource path
  local_var_path = '/correlation-rules/entities/rules/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"CorrelationRules.entities_rules_delete_v1",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorrelationRules#entities_rules_delete_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entities_rules_get_v1(ids, opts = {}) ⇒ ApiGetEntitiesRulesResponseV1

Retrieve rules by IDs

Parameters:

  • ids (Array<String>) —

    The IDs

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

    the optional parameters

Returns:



640
641
642
643
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 640

def entities_rules_get_v1(ids, opts = {})
  data, _status_code, _headers = entities_rules_get_v1_with_http_info(ids, opts)
  data
end

#entities_rules_get_v1_with_http_info(ids, opts = {}) ⇒ Array<(ApiGetEntitiesRulesResponseV1, Integer, Hash)>

Retrieve rules by IDs

Parameters:

  • ids (Array<String>) —

    The IDs

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

    the optional parameters

Returns:



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 649

def entities_rules_get_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CorrelationRules.entities_rules_get_v1 ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling CorrelationRules.entities_rules_get_v1"
  end
  # resource path
  local_var_path = '/correlation-rules/entities/rules/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"CorrelationRules.entities_rules_get_v1",
    :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: CorrelationRules#entities_rules_get_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entities_rules_get_v2(ids, opts = {}) ⇒ ApiGetEntitiesRulesResponseV1

Retrieve rule versions by IDs

Parameters:

  • ids (Array<String>) —

    The IDs

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

    the optional parameters

Returns:



702
703
704
705
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 702

def entities_rules_get_v2(ids, opts = {})
  data, _status_code, _headers = entities_rules_get_v2_with_http_info(ids, opts)
  data
end

#entities_rules_get_v2_with_http_info(ids, opts = {}) ⇒ Array<(ApiGetEntitiesRulesResponseV1, Integer, Hash)>

Retrieve rule versions by IDs

Parameters:

  • ids (Array<String>) —

    The IDs

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

    the optional parameters

Returns:



711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 711

def entities_rules_get_v2_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CorrelationRules.entities_rules_get_v2 ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling CorrelationRules.entities_rules_get_v2"
  end
  # resource path
  local_var_path = '/correlation-rules/entities/rules/v2'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"CorrelationRules.entities_rules_get_v2",
    :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: CorrelationRules#entities_rules_get_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entities_rules_patch_v1(body, opts = {}) ⇒ ApiGetEntitiesRulesResponseV1

Update rules

Parameters:

Returns:



764
765
766
767
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 764

def entities_rules_patch_v1(body, opts = {})
  data, _status_code, _headers = entities_rules_patch_v1_with_http_info(body, opts)
  data
end

#entities_rules_patch_v1_with_http_info(body, opts = {}) ⇒ Array<(ApiGetEntitiesRulesResponseV1, Integer, Hash)>

Update rules

Parameters:

Returns:



773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 773

def entities_rules_patch_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CorrelationRules.entities_rules_patch_v1 ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CorrelationRules.entities_rules_patch_v1"
  end
  # resource path
  local_var_path = '/correlation-rules/entities/rules/v1'

  # 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/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/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(body)

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

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

  new_options = opts.merge(
    :operation => :"CorrelationRules.entities_rules_patch_v1",
    :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: CorrelationRules#entities_rules_patch_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#entities_rules_post_v1(body, opts = {}) ⇒ ApiGetEntitiesRulesResponseV1

Create rule

Parameters:

Returns:



830
831
832
833
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 830

def entities_rules_post_v1(body, opts = {})
  data, _status_code, _headers = entities_rules_post_v1_with_http_info(body, opts)
  data
end

#entities_rules_post_v1_with_http_info(body, opts = {}) ⇒ Array<(ApiGetEntitiesRulesResponseV1, Integer, Hash)>

Create rule

Parameters:

Returns:



839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 839

def entities_rules_post_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CorrelationRules.entities_rules_post_v1 ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CorrelationRules.entities_rules_post_v1"
  end
  # resource path
  local_var_path = '/correlation-rules/entities/rules/v1'

  # 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/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/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(body)

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

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

  new_options = opts.merge(
    :operation => :"CorrelationRules.entities_rules_post_v1",
    :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: CorrelationRules#entities_rules_post_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#queries_rules_get_v1(opts = {}) ⇒ MsaspecQueryResponse

Find all rule IDs matching the query and filter. Supported filters: customer_id,user_id,user_uuid,status,name,created_on,last_updated_on Supported range filters: created_on,last_updated_on

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL query specifying the filter parameters

  • :q (String) —

    Match query criteria, which includes all the filter string fields

  • :sort (String) —

    Rule property to sort on (default to ‘created_on’)

  • :offset (Integer) —

    Starting index of overall result set from which to return IDs (default to 0)

  • :limit (Integer) —

    Number of IDs to return (default to 100)

Returns:



900
901
902
903
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 900

def queries_rules_get_v1(opts = {})
  data, _status_code, _headers = queries_rules_get_v1_with_http_info(opts)
  data
end

#queries_rules_get_v1_with_http_info(opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>

Find all rule IDs matching the query and filter. Supported filters: customer_id,user_id,user_uuid,status,name,created_on,last_updated_on Supported range filters: created_on,last_updated_on

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL query specifying the filter parameters

  • :q (String) —

    Match query criteria, which includes all the filter string fields

  • :sort (String) —

    Rule property to sort on (default to ‘created_on’)

  • :offset (Integer) —

    Starting index of overall result set from which to return IDs (default to 0)

  • :limit (Integer) —

    Number of IDs to return (default to 100)

Returns:

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

    MsaspecQueryResponse data, response status code and response headers



913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 913

def queries_rules_get_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CorrelationRules.queries_rules_get_v1 ...'
  end
  allowable_values = ["created_on", "created_on|desc", "last_updated_on", "last_updated_on|desc"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/correlation-rules/queries/rules/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"CorrelationRules.queries_rules_get_v1",
    :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: CorrelationRules#queries_rules_get_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#queries_rules_get_v2(opts = {}) ⇒ MsaspecQueryResponse

Find all rule version IDs matching the query and filter. Supported filters: customer_id,user_id,user_uuid,status,name,created_on,last_updated_on,state,version,rule_id Supported range filters: created_on,last_updated_on

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL query specifying the filter parameters

  • :q (String) —

    Match query criteria, which includes all the filter string fields

  • :sort (String) —

    Rule property to sort on (default to ‘created_on’)

  • :offset (Integer) —

    Starting index of overall result set from which to return IDs (default to 0)

  • :limit (Integer) —

    Number of IDs to return (default to 100)

Returns:



974
975
976
977
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 974

def queries_rules_get_v2(opts = {})
  data, _status_code, _headers = queries_rules_get_v2_with_http_info(opts)
  data
end

#queries_rules_get_v2_with_http_info(opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>

Find all rule version IDs matching the query and filter. Supported filters: customer_id,user_id,user_uuid,status,name,created_on,last_updated_on,state,version,rule_id Supported range filters: created_on,last_updated_on

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL query specifying the filter parameters

  • :q (String) —

    Match query criteria, which includes all the filter string fields

  • :sort (String) —

    Rule property to sort on (default to ‘created_on’)

  • :offset (Integer) —

    Starting index of overall result set from which to return IDs (default to 0)

  • :limit (Integer) —

    Number of IDs to return (default to 100)

Returns:

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

    MsaspecQueryResponse data, response status code and response headers



987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'lib/crimson-falcon/api/correlation_rules.rb', line 987

def queries_rules_get_v2_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CorrelationRules.queries_rules_get_v2 ...'
  end
  allowable_values = ["created_on", "created_on|desc", "last_updated_on", "last_updated_on|desc"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/correlation-rules/queries/rules/v2'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"CorrelationRules.queries_rules_get_v2",
    :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: CorrelationRules#queries_rules_get_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end