Class: Falcon::MalqueryApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MalqueryApi

Returns a new instance of MalqueryApi.



36
37
38
 
# File 'lib/crimson-falcon/api/malquery_api.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/malquery_api.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#get_mal_query_download_v1(ids, opts = {}) ⇒ nil

Download a file indexed by MalQuery. Specify the file using its SHA256. Only one file is supported at this time

Parameters:

  • ids (Array<String>) —

    The file SHA256.

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

    the optional parameters

Returns:

  • (nil) 


43
44
45
46
 
# File 'lib/crimson-falcon/api/malquery_api.rb', line 43

def get_mal_query_download_v1(ids, opts = {})
  get_mal_query_download_v1_with_http_info(ids, opts)
  nil
end

#get_mal_query_download_v1_with_http_info(ids, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Download a file indexed by MalQuery. Specify the file using its SHA256. Only one file is supported at this time

Parameters:

  • ids (Array<String>) —

    The file SHA256.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
96
97
98
99
 
# File 'lib/crimson-falcon/api/malquery_api.rb', line 52

def get_mal_query_download_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MalqueryApi.get_mal_query_download_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 MalqueryApi.get_mal_query_download_v1"
  end
  # resource path
  local_var_path = '/malquery/entities/download-files/v1'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', '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]

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

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

#get_mal_query_entities_samples_fetch_v1(ids, opts = {}) ⇒ nil

Fetch a zip archive with password ‘infected’ containing the samples. Call this once the /entities/samples-multidownload request has finished processing

Parameters:

  • ids (String) —

    Multidownload job id

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

    the optional parameters

Returns:

  • (nil) 


105
106
107
108
 
# File 'lib/crimson-falcon/api/malquery_api.rb', line 105

def get_mal_query_entities_samples_fetch_v1(ids, opts = {})
  get_mal_query_entities_samples_fetch_v1_with_http_info(ids, opts)
  nil
end

#get_mal_query_entities_samples_fetch_v1_with_http_info(ids, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Fetch a zip archive with password &#39;infected&#39; containing the samples. Call this once the /entities/samples-multidownload request has finished processing

Parameters:

  • ids (String) —

    Multidownload job id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



114
115
116
117
118
119
120
121
122
123
124
125
126
127
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
 
# File 'lib/crimson-falcon/api/malquery_api.rb', line 114

def get_mal_query_entities_samples_fetch_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MalqueryApi.get_mal_query_entities_samples_fetch_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 MalqueryApi.get_mal_query_entities_samples_fetch_v1"
  end
  # resource path
  local_var_path = '/malquery/entities/samples-fetch/v1'

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

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

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

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

#get_mal_query_metadata_v1(ids, opts = {}) ⇒ MalquerySampleMetadataResponse

Retrieve indexed files metadata by their hash

Parameters:

  • ids (Array<String>) —

    The file SHA256.

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

    the optional parameters

Returns:



167
168
169
170
 
# File 'lib/crimson-falcon/api/malquery_api.rb', line 167

def get_mal_query_metadata_v1(ids, opts = {})
  data, _status_code, _headers = get_mal_query_metadata_v1_with_http_info(ids, opts)
  data
end

#get_mal_query_metadata_v1_with_http_info(ids, opts = {}) ⇒ Array<(MalquerySampleMetadataResponse, Integer, Hash)>

Retrieve indexed files metadata by their hash

Parameters:

  • ids (Array<String>) —

    The file SHA256.

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

    the optional parameters

Returns:



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/crimson-falcon/api/malquery_api.rb', line 176

def get_mal_query_metadata_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MalqueryApi.get_mal_query_metadata_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 MalqueryApi.get_mal_query_metadata_v1"
  end
  # resource path
  local_var_path = '/malquery/entities/metadata/v1'

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

  # 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] || 'MalquerySampleMetadataResponse'

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

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

#get_mal_query_quotas_v1(opts = {}) ⇒ MalqueryRateLimitsResponse

Get information about search and download quotas in your environment

Parameters:

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

    the optional parameters

Returns:



228
229
230
231
 
# File 'lib/crimson-falcon/api/malquery_api.rb', line 228

def get_mal_query_quotas_v1(opts = {})
  data, _status_code, _headers = get_mal_query_quotas_v1_with_http_info(opts)
  data
end

#get_mal_query_quotas_v1_with_http_info(opts = {}) ⇒ Array<(MalqueryRateLimitsResponse, Integer, Hash)>

Get information about search and download quotas in your environment

Parameters:

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

    the optional parameters

Returns:

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

    MalqueryRateLimitsResponse data, response status code and response headers



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

def get_mal_query_quotas_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MalqueryApi.get_mal_query_quotas_v1 ...'
  end
  # resource path
  local_var_path = '/malquery/aggregates/quotas/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] || 'MalqueryRateLimitsResponse'

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

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

#get_mal_query_request_v1(ids, opts = {}) ⇒ MalqueryRequestResponse

Check the status and results of an asynchronous request, such as hunt or exact-search. Supports a single request id at this time.

Parameters:

  • ids (Array<String>) —

    Identifier of a MalQuery request

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

    the optional parameters

Returns:



284
285
286
287
 
# File 'lib/crimson-falcon/api/malquery_api.rb', line 284

def get_mal_query_request_v1(ids, opts = {})
  data, _status_code, _headers = get_mal_query_request_v1_with_http_info(ids, opts)
  data
end

#get_mal_query_request_v1_with_http_info(ids, opts = {}) ⇒ Array<(MalqueryRequestResponse, Integer, Hash)>

Check the status and results of an asynchronous request, such as hunt or exact-search. Supports a single request id at this time.

Parameters:

  • ids (Array<String>) —

    Identifier of a MalQuery request

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

    the optional parameters

Returns:

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

    MalqueryRequestResponse data, response status code and response headers



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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/crimson-falcon/api/malquery_api.rb', line 293

def get_mal_query_request_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MalqueryApi.get_mal_query_request_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 MalqueryApi.get_mal_query_request_v1"
  end
  # resource path
  local_var_path = '/malquery/entities/requests/v1'

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

  # 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] || 'MalqueryRequestResponse'

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

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

#post_mal_query_entities_samples_multidownload_v1(body, opts = {}) ⇒ MalqueryExternalQueryResponse

Schedule samples for download. Use the result id with the /request endpoint to check if the download is ready after which you can call the /entities/samples-fetch to get the zip

Parameters:

Returns:



346
347
348
349
 
# File 'lib/crimson-falcon/api/malquery_api.rb', line 346

def post_mal_query_entities_samples_multidownload_v1(body, opts = {})
  data, _status_code, _headers = post_mal_query_entities_samples_multidownload_v1_with_http_info(body, opts)
  data
end

#post_mal_query_entities_samples_multidownload_v1_with_http_info(body, opts = {}) ⇒ Array<(MalqueryExternalQueryResponse, Integer, Hash)>

Schedule samples for download. Use the result id with the /request endpoint to check if the download is ready after which you can call the /entities/samples-fetch to get the zip

Parameters:

Returns:



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
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/crimson-falcon/api/malquery_api.rb', line 355

def post_mal_query_entities_samples_multidownload_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MalqueryApi.post_mal_query_entities_samples_multidownload_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 MalqueryApi.post_mal_query_entities_samples_multidownload_v1"
  end
  # resource path
  local_var_path = '/malquery/entities/samples-multidownload/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] || 'MalqueryExternalQueryResponse'

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

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

#post_mal_query_exact_search_v1(body, opts = {}) ⇒ MalqueryExternalQueryResponse

Search Falcon MalQuery for a combination of hex patterns and strings in order to identify samples based upon file content at byte level granularity. You can filter results on criteria such as file type, file size and first seen date. Returns a request id which can be used with the /request endpoint

Parameters:

Returns:



412
413
414
415
 
# File 'lib/crimson-falcon/api/malquery_api.rb', line 412

def post_mal_query_exact_search_v1(body, opts = {})
  data, _status_code, _headers = post_mal_query_exact_search_v1_with_http_info(body, opts)
  data
end

#post_mal_query_exact_search_v1_with_http_info(body, opts = {}) ⇒ Array<(MalqueryExternalQueryResponse, Integer, Hash)>

Search Falcon MalQuery for a combination of hex patterns and strings in order to identify samples based upon file content at byte level granularity. You can filter results on criteria such as file type, file size and first seen date. Returns a request id which can be used with the /request endpoint

Parameters:

Returns:



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
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/crimson-falcon/api/malquery_api.rb', line 421

def post_mal_query_exact_search_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MalqueryApi.post_mal_query_exact_search_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 MalqueryApi.post_mal_query_exact_search_v1"
  end
  # resource path
  local_var_path = '/malquery/queries/exact-search/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] || 'MalqueryExternalQueryResponse'

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

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

#post_mal_query_fuzzy_search_v1(body, opts = {}) ⇒ MalqueryFuzzySearchResponse

Search Falcon MalQuery quickly, but with more potential for false positives. Search for a combination of hex patterns and strings in order to identify samples based upon file content at byte level granularity.

Parameters:

  • body (MalqueryFuzzySearchParametersV1) —

    Fuzzy search parameters. See model for more details.

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

    the optional parameters

Returns:



478
479
480
481
 
# File 'lib/crimson-falcon/api/malquery_api.rb', line 478

def post_mal_query_fuzzy_search_v1(body, opts = {})
  data, _status_code, _headers = post_mal_query_fuzzy_search_v1_with_http_info(body, opts)
  data
end

#post_mal_query_fuzzy_search_v1_with_http_info(body, opts = {}) ⇒ Array<(MalqueryFuzzySearchResponse, Integer, Hash)>

Search Falcon MalQuery quickly, but with more potential for false positives. Search for a combination of hex patterns and strings in order to identify samples based upon file content at byte level granularity.

Parameters:

  • body (MalqueryFuzzySearchParametersV1) —

    Fuzzy search parameters. See model for more details.

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

    the optional parameters

Returns:

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

    MalqueryFuzzySearchResponse data, response status code and response headers



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/crimson-falcon/api/malquery_api.rb', line 487

def post_mal_query_fuzzy_search_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MalqueryApi.post_mal_query_fuzzy_search_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 MalqueryApi.post_mal_query_fuzzy_search_v1"
  end
  # resource path
  local_var_path = '/malquery/combined/fuzzy-search/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] || 'MalqueryFuzzySearchResponse'

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

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

#post_mal_query_hunt_v1(body, opts = {}) ⇒ MalqueryExternalQueryResponse

Schedule a YARA-based search for execution. Returns a request id which can be used with the /request endpoint

Parameters:

Returns:



544
545
546
547
 
# File 'lib/crimson-falcon/api/malquery_api.rb', line 544

def post_mal_query_hunt_v1(body, opts = {})
  data, _status_code, _headers = post_mal_query_hunt_v1_with_http_info(body, opts)
  data
end

#post_mal_query_hunt_v1_with_http_info(body, opts = {}) ⇒ Array<(MalqueryExternalQueryResponse, Integer, Hash)>

Schedule a YARA-based search for execution. Returns a request id which can be used with the /request endpoint

Parameters:

Returns:



553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
 
# File 'lib/crimson-falcon/api/malquery_api.rb', line 553

def post_mal_query_hunt_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MalqueryApi.post_mal_query_hunt_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 MalqueryApi.post_mal_query_hunt_v1"
  end
  # resource path
  local_var_path = '/malquery/queries/hunt/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] || 'MalqueryExternalQueryResponse'

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

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