Class: Falcon::Default

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Default

Returns a new instance of Default.



35
36
37
 
# File 'lib/crimson-falcon/api/default.rb', line 35

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



33
34
35
 
# File 'lib/crimson-falcon/api/default.rb', line 33

def api_client
  @api_client
end

Instance Method Details

#combined_query_installed_patches(opts = {}) ⇒ DomainSPAPICombinedInstalledPatchesResponse

Get installed patches information for hosts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :after (String) —

    Pagination token for next page

  • :limit (Integer) —

    Maximum number of results

  • :filter (String) —

    FQL query specifying the filter parameters. Empty value means to not filter on anything. Available filter fields that supports exact match: aid, cid, hostname, reboot_required Available filter fields that supports wildcard (*): N/A Available filter fields that supports range comparisons (>, <, >=, <=): N/A All filter fields and operations supports negation (!)

  • :sort (String) —

    Sort field and direction. Available sort fields: hostname. Ex: 'hostname|asc' or 'hostname|desc'.

Returns:



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

def combined_query_installed_patches(opts = {})
  data, _status_code, _headers = combined_query_installed_patches_with_http_info(opts)
  data
end

#combined_query_installed_patches_with_http_info(opts = {}) ⇒ Array<(DomainSPAPICombinedInstalledPatchesResponse, Integer, Hash)>

Get installed patches information for hosts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :after (String) —

    Pagination token for next page

  • :limit (Integer) —

    Maximum number of results

  • :filter (String) —

    FQL query specifying the filter parameters. Empty value means to not filter on anything. Available filter fields that supports exact match: aid, cid, hostname, reboot_required Available filter fields that supports wildcard (*): N/A Available filter fields that supports range comparisons (&gt;, &lt;, &gt;&#x3D;, &lt;&#x3D;): N/A All filter fields and operations supports negation (!)

  • :sort (String) —

    Sort field and direction. Available sort fields: hostname. Ex: &#39;hostname|asc&#39; or &#39;hostname|desc&#39;.

Returns:



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

def combined_query_installed_patches_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.combined_query_installed_patches ...'
  end
  # resource path
  local_var_path = '/spotlight/combined/installed-patches/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'DomainSPAPICombinedInstalledPatchesResponse'

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

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

#delete_collections_v1(opts = {}) ⇒ DomainEntitiesCollectionsResponseV1

Cancel Collections

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Collection IDs

Returns:



109
110
111
112
 
# File 'lib/crimson-falcon/api/default.rb', line 109

def delete_collections_v1(opts = {})
  data, _status_code, _headers = delete_collections_v1_with_http_info(opts)
  data
end

#delete_collections_v1_with_http_info(opts = {}) ⇒ Array<(DomainEntitiesCollectionsResponseV1, Integer, Hash)>

Cancel Collections

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Collection IDs

Returns:



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/default.rb', line 118

def delete_collections_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.delete_collections_v1 ...'
  end
  # resource path
  local_var_path = '/forensics/entities/collections/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].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] || 'DomainEntitiesCollectionsResponseV1'

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

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

#delete_configs_v1(ids, opts = {}) ⇒ DomainEntitiesConfigurationsResponseV1

Retires a custom configuration

Parameters:

  • ids (Array<String>) —

    Configuration IDs

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

    the optional parameters

Returns:



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

def delete_configs_v1(ids, opts = {})
  data, _status_code, _headers = delete_configs_v1_with_http_info(ids, opts)
  data
end

#delete_configs_v1_with_http_info(ids, opts = {}) ⇒ Array<(DomainEntitiesConfigurationsResponseV1, Integer, Hash)>

Retires a custom configuration

Parameters:

  • ids (Array<String>) —

    Configuration IDs

  • 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/default.rb', line 176

def delete_configs_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.delete_configs_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 Default.delete_configs_v1"
  end
  # resource path
  local_var_path = '/forensics/entities/configurations/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', 'application/yaml'])

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

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

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

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

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

#get_collection_counts_by_v1(opts = {}) ⇒ DomainAggregateCollectionCountsByResponseV1

Get Collection counts by field names: collection_tag and state

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL filter

  • :limit (String) —

    Limit

  • :offset (String) —

    Offset

  • :sort (String) —

    Sort

Returns:



232
233
234
235
 
# File 'lib/crimson-falcon/api/default.rb', line 232

def get_collection_counts_by_v1(opts = {})
  data, _status_code, _headers = get_collection_counts_by_v1_with_http_info(opts)
  data
end

#get_collection_counts_by_v1_with_http_info(opts = {}) ⇒ Array<(DomainAggregateCollectionCountsByResponseV1, Integer, Hash)>

Get Collection counts by field names: collection_tag and state

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL filter

  • :limit (String) —

    Limit

  • :offset (String) —

    Offset

  • :sort (String) —

    Sort

Returns:



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
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/crimson-falcon/api/default.rb', line 244

def get_collection_counts_by_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.get_collection_counts_by_v1 ...'
  end
  allowable_values = ["collection_tag|asc", "collection_tag|desc", "state|asc", "state|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 = '/forensics/aggregate/collection-counts-by/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'DomainAggregateCollectionCountsByResponseV1'

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

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

#get_collections_v1(opts = {}) ⇒ DomainEntitiesCollectionsResponseV1

Get Collections with given IDs, Platform, Agent/Collector IDs, States

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Collection IDs

  • :platform (String) —

    Platform

  • :aids (Array<String>) —

    Agent IDs

  • :ffcids (Array<String>) —

    Falcon Forensics Collector IDs

  • :states (Array<String>) —

    Falcon Forensics Collection States

  • :sort (String) —

    Sort

Returns:



305
306
307
308
 
# File 'lib/crimson-falcon/api/default.rb', line 305

def get_collections_v1(opts = {})
  data, _status_code, _headers = get_collections_v1_with_http_info(opts)
  data
end

#get_collections_v1_with_http_info(opts = {}) ⇒ Array<(DomainEntitiesCollectionsResponseV1, Integer, Hash)>

Get Collections with given IDs, Platform, Agent/Collector IDs, States

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Collection IDs

  • :platform (String) —

    Platform

  • :aids (Array<String>) —

    Agent IDs

  • :ffcids (Array<String>) —

    Falcon Forensics Collector IDs

  • :states (Array<String>) —

    Falcon Forensics Collection States

  • :sort (String) —

    Sort

Returns:



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
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/crimson-falcon/api/default.rb', line 319

def get_collections_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.get_collections_v1 ...'
  end
  allowable_values = ["windows", "linux", "mac"]
  if @api_client.config.client_side_validation && opts[:'platform'] && !allowable_values.include?(opts[:'platform'])
    fail ArgumentError, "invalid value for \"platform\", must be one of #{allowable_values}"
  end
  allowable_values = ["deadline|asc", "deadline|desc", "id|asc", "id|desc", "priority|asc", "priority|desc", "state|asc", "state|desc", "modified_timestamp|asc", "modified_timestamp|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 = '/forensics/entities/collections/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
  query_params[:'aids'] = @api_client.build_collection_param(opts[:'aids'], :csv) if !opts[:'aids'].nil?
  query_params[:'ffcids'] = @api_client.build_collection_param(opts[:'ffcids'], :csv) if !opts[:'ffcids'].nil?
  query_params[:'states'] = @api_client.build_collection_param(opts[:'states'], :csv) if !opts[:'states'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'DomainEntitiesCollectionsResponseV1'

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

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

#get_collectors_v1(opts = {}) ⇒ DomainEntitiesCollectorsResponseV1

Get collectors

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Collector IDs

  • :platform (String) —

    Platform

  • :sort (String) —

    Sort

Returns:



383
384
385
386
 
# File 'lib/crimson-falcon/api/default.rb', line 383

def get_collectors_v1(opts = {})
  data, _status_code, _headers = get_collectors_v1_with_http_info(opts)
  data
end

#get_collectors_v1_with_http_info(opts = {}) ⇒ Array<(DomainEntitiesCollectorsResponseV1, Integer, Hash)>

Get collectors

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Collector IDs

  • :platform (String) —

    Platform

  • :sort (String) —

    Sort

Returns:



394
395
396
397
398
399
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
 
# File 'lib/crimson-falcon/api/default.rb', line 394

def get_collectors_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.get_collectors_v1 ...'
  end
  allowable_values = ["windows", "linux", "mac"]
  if @api_client.config.client_side_validation && opts[:'platform'] && !allowable_values.include?(opts[:'platform'])
    fail ArgumentError, "invalid value for \"platform\", must be one of #{allowable_values}"
  end
  allowable_values = ["null", "aid|asc", "aid|desc", "ffcid|asc", "ffcid|desc", "platform|asc", "platform|desc", "modified_timestamp|asc", "modified_timestamp|desc", "state|asc", "state|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 = '/forensics/entities/collectors/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'DomainEntitiesCollectorsResponseV1'

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

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

#get_combined_collections_v1(opts = {}) ⇒ DomainEntitiesCollectionsResponseV1

Get Collections with given IDs, Platform, Agent/Collector IDs, States

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Collection IDs

  • :filter (String) —

    FQL filter

  • :limit (String) —

    Limit

  • :offset (String) —

    Offset

  • :sort (String) —

    Sort

Returns:



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

def get_combined_collections_v1(opts = {})
  data, _status_code, _headers = get_combined_collections_v1_with_http_info(opts)
  data
end

#get_combined_collections_v1_with_http_info(opts = {}) ⇒ Array<(DomainEntitiesCollectionsResponseV1, Integer, Hash)>

Get Collections with given IDs, Platform, Agent/Collector IDs, States

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Collection IDs

  • :filter (String) —

    FQL filter

  • :limit (String) —

    Limit

  • :offset (String) —

    Offset

  • :sort (String) —

    Sort

Returns:



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
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/crimson-falcon/api/default.rb', line 470

def get_combined_collections_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.get_combined_collections_v1 ...'
  end
  allowable_values = ["deadline|asc", "deadline|desc", "id|asc", "id|desc", "priority|asc", "priority|desc", "state|asc", "state|desc", "modified_timestamp|asc", "modified_timestamp|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 = '/forensics/combined/collections/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'DomainEntitiesCollectionsResponseV1'

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

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

#get_combined_collectors_v1(opts = {}) ⇒ DomainEntitiesCollectorsResponseV1

Get collectors for the given Customer ID

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Collector IDs

  • :filter (String) —

    FQL filter

  • :limit (String) —

    Limit

  • :offset (String) —

    Offset

  • :sort (String) —

    Sort

Returns:



531
532
533
534
 
# File 'lib/crimson-falcon/api/default.rb', line 531

def get_combined_collectors_v1(opts = {})
  data, _status_code, _headers = get_combined_collectors_v1_with_http_info(opts)
  data
end

#get_combined_collectors_v1_with_http_info(opts = {}) ⇒ Array<(DomainEntitiesCollectorsResponseV1, Integer, Hash)>

Get collectors for the given Customer ID

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Collector IDs

  • :filter (String) —

    FQL filter

  • :limit (String) —

    Limit

  • :offset (String) —

    Offset

  • :sort (String) —

    Sort

Returns:



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
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/crimson-falcon/api/default.rb', line 544

def get_combined_collectors_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.get_combined_collectors_v1 ...'
  end
  allowable_values = ["null", "aid|asc", "aid|desc", "ffcid|asc", "ffcid|desc", "platform|asc", "platform|desc", "modified_timestamp|asc", "modified_timestamp|desc", "state|asc", "state|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 = '/forensics/combined/collectors/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'DomainEntitiesCollectorsResponseV1'

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

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

#get_combined_configs_v1(opts = {}) ⇒ DomainEntitiesConfigurationsResponseV1

Get Configurations for the given Customer ID

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Configuration IDs

  • :filter (String) —

    FQL filter

  • :limit (String) —

    Limit

  • :offset (String) —

    Offset

  • :sort (String) —

    Sort

Returns:



605
606
607
608
 
# File 'lib/crimson-falcon/api/default.rb', line 605

def get_combined_configs_v1(opts = {})
  data, _status_code, _headers = get_combined_configs_v1_with_http_info(opts)
  data
end

#get_combined_configs_v1_with_http_info(opts = {}) ⇒ Array<(DomainEntitiesConfigurationsResponseV1, Integer, Hash)>

Get Configurations for the given Customer ID

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Configuration IDs

  • :filter (String) —

    FQL filter

  • :limit (String) —

    Limit

  • :offset (String) —

    Offset

  • :sort (String) —

    Sort

Returns:



618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/crimson-falcon/api/default.rb', line 618

def get_combined_configs_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.get_combined_configs_v1 ...'
  end
  allowable_values = ["null", "id|asc", "id|desc", "name|asc", "name|desc", "modified_timestamp|asc", "modified_timestamp|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 = '/forensics/combined/configurations/v1'

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

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

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

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

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

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

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

#get_combined_templates_v1(opts = {}) ⇒ DomainEntitiesTemplatesResponseV1

Get Templates with the given IDs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Template IDs

  • :filter (String) —

    FQL filter

  • :limit (String) —

    Limit

  • :offset (String) —

    Offset

  • :sort (String) —

    Sort

Returns:



679
680
681
682
 
# File 'lib/crimson-falcon/api/default.rb', line 679

def get_combined_templates_v1(opts = {})
  data, _status_code, _headers = get_combined_templates_v1_with_http_info(opts)
  data
end

#get_combined_templates_v1_with_http_info(opts = {}) ⇒ Array<(DomainEntitiesTemplatesResponseV1, Integer, Hash)>

Get Templates with the given IDs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Template IDs

  • :filter (String) —

    FQL filter

  • :limit (String) —

    Limit

  • :offset (String) —

    Offset

  • :sort (String) —

    Sort

Returns:



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
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
 
# File 'lib/crimson-falcon/api/default.rb', line 692

def get_combined_templates_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.get_combined_templates_v1 ...'
  end
  allowable_values = ["id|asc", "id|desc", "name|asc", "name|desc", "modified_timestamp|asc", "modified_timestamp|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 = '/forensics/combined/templates/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'DomainEntitiesTemplatesResponseV1'

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

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

#get_config_download_v1(id, opts = {}) ⇒ Array<Integer>

Download offline Configuration file using ID

Parameters:

  • id (String) —

    Configuration ID

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

    the optional parameters

Options Hash (opts):

  • :collection_tag (String) —

    Configuration Collection Tag

  • :self_destruct (Boolean) —

    Self-Destruct config

Returns:

  • (Array<Integer>) 


751
752
753
754
 
# File 'lib/crimson-falcon/api/default.rb', line 751

def get_config_download_v1(id, opts = {})
  data, _status_code, _headers = get_config_download_v1_with_http_info(id, opts)
  data
end

#get_config_download_v1_with_http_info(id, opts = {}) ⇒ Array<(Array<Integer>, Integer, Hash)>

Download offline Configuration file using ID

Parameters:

  • id (String) —

    Configuration ID

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

    the optional parameters

Options Hash (opts):

  • :collection_tag (String) —

    Configuration Collection Tag

  • :self_destruct (Boolean) —

    Self-Destruct config

Returns:

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

    Array<Integer> data, response status code and response headers



762
763
764
765
766
767
768
769
770
771
772
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
 
# File 'lib/crimson-falcon/api/default.rb', line 762

def get_config_download_v1_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.get_config_download_v1 ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling Default.get_config_download_v1"
  end
  # resource path
  local_var_path = '/forensics/entities/configuration-download/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id
  query_params[:'collection_tag'] = opts[:'collection_tag'] if !opts[:'collection_tag'].nil?
  query_params[:'self_destruct'] = opts[:'self_destruct'] if !opts[:'self_destruct'].nil?

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Integer>'

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

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

#get_configs_v1(ids, opts = {}) ⇒ DomainEntitiesConfigurationsResponseV1

Get Configurations with the given IDs

Parameters:

  • ids (Array<String>) —

    Configuration IDs

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

    the optional parameters

Returns:



817
818
819
820
 
# File 'lib/crimson-falcon/api/default.rb', line 817

def get_configs_v1(ids, opts = {})
  data, _status_code, _headers = get_configs_v1_with_http_info(ids, opts)
  data
end

#get_configs_v1_with_http_info(ids, opts = {}) ⇒ Array<(DomainEntitiesConfigurationsResponseV1, Integer, Hash)>

Get Configurations with the given IDs

Parameters:

  • ids (Array<String>) —

    Configuration IDs

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

    the optional parameters

Returns:



826
827
828
829
830
831
832
833
834
835
836
837
838
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
 
# File 'lib/crimson-falcon/api/default.rb', line 826

def get_configs_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.get_configs_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 Default.get_configs_v1"
  end
  # resource path
  local_var_path = '/forensics/entities/configurations/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', 'application/yaml'])

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

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

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

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

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

#get_templates_v1(ids, opts = {}) ⇒ DomainEntitiesTemplatesResponseV1

Get Templates with the given IDs

Parameters:

  • ids (Array<String>) —

    Template IDs

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

    the optional parameters

Returns:



879
880
881
882
 
# File 'lib/crimson-falcon/api/default.rb', line 879

def get_templates_v1(ids, opts = {})
  data, _status_code, _headers = get_templates_v1_with_http_info(ids, opts)
  data
end

#get_templates_v1_with_http_info(ids, opts = {}) ⇒ Array<(DomainEntitiesTemplatesResponseV1, Integer, Hash)>

Get Templates with the given IDs

Parameters:

  • ids (Array<String>) —

    Template IDs

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

    the optional parameters

Returns:



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'lib/crimson-falcon/api/default.rb', line 888

def get_templates_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.get_templates_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 Default.get_templates_v1"
  end
  # resource path
  local_var_path = '/forensics/entities/templates/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] || 'DomainEntitiesTemplatesResponseV1'

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

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

#post_collections_v1(body, opts = {}) ⇒ DomainEntitiesCollectionsResponseV1

Create Collections

Parameters:

Returns:



941
942
943
944
 
# File 'lib/crimson-falcon/api/default.rb', line 941

def post_collections_v1(body, opts = {})
  data, _status_code, _headers = post_collections_v1_with_http_info(body, opts)
  data
end

#post_collections_v1_with_http_info(body, opts = {}) ⇒ Array<(DomainEntitiesCollectionsResponseV1, Integer, Hash)>

Create Collections

Parameters:

Returns:



950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
 
# File 'lib/crimson-falcon/api/default.rb', line 950

def post_collections_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.post_collections_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 Default.post_collections_v1"
  end
  # resource path
  local_var_path = '/forensics/entities/collections/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] || 'DomainEntitiesCollectionsResponseV1'

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

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

#post_collectors_v1(body, opts = {}) ⇒ DomainEntitiesCollectorsResponseV1

shutdown collectors with self_destruct option

Parameters:

Returns:



1007
1008
1009
1010
 
# File 'lib/crimson-falcon/api/default.rb', line 1007

def post_collectors_v1(body, opts = {})
  data, _status_code, _headers = post_collectors_v1_with_http_info(body, opts)
  data
end

#post_collectors_v1_with_http_info(body, opts = {}) ⇒ Array<(DomainEntitiesCollectorsResponseV1, Integer, Hash)>

shutdown collectors with self_destruct option

Parameters:

Returns:



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
 
# File 'lib/crimson-falcon/api/default.rb', line 1016

def post_collectors_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.post_collectors_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 Default.post_collectors_v1"
  end
  # resource path
  local_var_path = '/forensics/entities/collectors-shutdown/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] || 'DomainEntitiesCollectorsResponseV1'

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

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

#post_configs_v1(body, opts = {}) ⇒ DomainEntitiesConfigurationsResponseV1

Creates a new custom configuration

Parameters:

Returns:



1073
1074
1075
1076
 
# File 'lib/crimson-falcon/api/default.rb', line 1073

def post_configs_v1(body, opts = {})
  data, _status_code, _headers = post_configs_v1_with_http_info(body, opts)
  data
end

#post_configs_v1_with_http_info(body, opts = {}) ⇒ Array<(DomainEntitiesConfigurationsResponseV1, Integer, Hash)>

Creates a new custom configuration

Parameters:

Returns:



1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'lib/crimson-falcon/api/default.rb', line 1082

def post_configs_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.post_configs_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 Default.post_configs_v1"
  end
  # resource path
  local_var_path = '/forensics/entities/configurations/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', 'application/yaml'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/yaml'])
  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] || 'DomainEntitiesConfigurationsResponseV1'

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

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

#post_deploy_v1(body, opts = {}) ⇒ DomainEntitiesCollectorsResponseV1

deploy collector to managed endpoints

Parameters:

Returns:



1139
1140
1141
1142
 
# File 'lib/crimson-falcon/api/default.rb', line 1139

def post_deploy_v1(body, opts = {})
  data, _status_code, _headers = post_deploy_v1_with_http_info(body, opts)
  data
end

#post_deploy_v1_with_http_info(body, opts = {}) ⇒ Array<(DomainEntitiesCollectorsResponseV1, Integer, Hash)>

deploy collector to managed endpoints

Parameters:

Returns:



1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'lib/crimson-falcon/api/default.rb', line 1148

def post_deploy_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.post_deploy_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 Default.post_deploy_v1"
  end
  # resource path
  local_var_path = '/forensics/entities/collectors-deploy/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] || 'DomainEntitiesCollectorsResponseV1'

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

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

#post_graphql_query_mixin0(opts = {}) ⇒ Hash<String, Object>

  • request graphql query

Parameters:

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


1204
1205
1206
1207
 
# File 'lib/crimson-falcon/api/default.rb', line 1204

def post_graphql_query_mixin0(opts = {})
  data, _status_code, _headers = post_graphql_query_mixin0_with_http_info(opts)
  data
end

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

  • request graphql query

Parameters:

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

    the optional parameters

Returns:

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

    Hash<String, Object> data, response status code and response headers



1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
 
# File 'lib/crimson-falcon/api/default.rb', line 1212

def post_graphql_query_mixin0_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.post_graphql_query_mixin0 ...'
  end
  # resource path
  local_var_path = '/cloud-data-protection/entities/schedules/graphql/v2'

  # 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] || 'Hash<String, Object>'

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

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

#put_collections_v1(body, opts = {}) ⇒ DomainEntitiesCollectionsResponseV1

Update Collections

Parameters:

Returns:



1260
1261
1262
1263
 
# File 'lib/crimson-falcon/api/default.rb', line 1260

def put_collections_v1(body, opts = {})
  data, _status_code, _headers = put_collections_v1_with_http_info(body, opts)
  data
end

#put_collections_v1_with_http_info(body, opts = {}) ⇒ Array<(DomainEntitiesCollectionsResponseV1, Integer, Hash)>

Update Collections

Parameters:

Returns:



1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
 
# File 'lib/crimson-falcon/api/default.rb', line 1269

def put_collections_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.put_collections_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 Default.put_collections_v1"
  end
  # resource path
  local_var_path = '/forensics/entities/collections/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] || 'DomainEntitiesCollectionsResponseV1'

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

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

#put_configs_v1(body, opts = {}) ⇒ DomainEntitiesConfigurationsResponseV1

Creates or replaces an existing custom configuration

Parameters:

Returns:



1326
1327
1328
1329
 
# File 'lib/crimson-falcon/api/default.rb', line 1326

def put_configs_v1(body, opts = {})
  data, _status_code, _headers = put_configs_v1_with_http_info(body, opts)
  data
end

#put_configs_v1_with_http_info(body, opts = {}) ⇒ Array<(DomainEntitiesConfigurationsResponseV1, Integer, Hash)>

Creates or replaces an existing custom configuration

Parameters:

Returns:



1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
 
# File 'lib/crimson-falcon/api/default.rb', line 1335

def put_configs_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.put_configs_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 Default.put_configs_v1"
  end
  # resource path
  local_var_path = '/forensics/entities/configurations/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', 'application/yaml'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/yaml'])
  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] || 'DomainEntitiesConfigurationsResponseV1'

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

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

#search_collections_v1(opts = {}) ⇒ DomainQueriesResponseV1

Search Collections for the given Customer ID and/or Platform in states

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :platform (String) —

    Platform

  • :states (Array<String>) —

    Falcon Forensics Collection States

  • :aids (Array<String>) —

    Agent IDs

  • :ffcids (Array<String>) —

    Falcon Forensics Collector IDs

  • :filter (String) —

    FQL filter

  • :limit (String) —

    Limit

  • :offset (String) —

    Offset

  • :sort (String) —

    Sort

Returns:



1399
1400
1401
1402
 
# File 'lib/crimson-falcon/api/default.rb', line 1399

def search_collections_v1(opts = {})
  data, _status_code, _headers = search_collections_v1_with_http_info(opts)
  data
end

#search_collections_v1_with_http_info(opts = {}) ⇒ Array<(DomainQueriesResponseV1, Integer, Hash)>

Search Collections for the given Customer ID and/or Platform in states

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :platform (String) —

    Platform

  • :states (Array<String>) —

    Falcon Forensics Collection States

  • :aids (Array<String>) —

    Agent IDs

  • :ffcids (Array<String>) —

    Falcon Forensics Collector IDs

  • :filter (String) —

    FQL filter

  • :limit (String) —

    Limit

  • :offset (String) —

    Offset

  • :sort (String) —

    Sort

Returns:

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

    DomainQueriesResponseV1 data, response status code and response headers



1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
 
# File 'lib/crimson-falcon/api/default.rb', line 1415

def search_collections_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.search_collections_v1 ...'
  end
  allowable_values = ["windows", "linux", "mac"]
  if @api_client.config.client_side_validation && opts[:'platform'] && !allowable_values.include?(opts[:'platform'])
    fail ArgumentError, "invalid value for \"platform\", must be one of #{allowable_values}"
  end
  allowable_values = ["deadline|asc", "deadline|desc", "id|asc", "id|desc", "priority|asc", "priority|desc", "state|asc", "state|desc", "modified_timestamp|asc", "modified_timestamp|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 = '/forensics/queries/collections/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
  query_params[:'states'] = @api_client.build_collection_param(opts[:'states'], :csv) if !opts[:'states'].nil?
  query_params[:'aids'] = @api_client.build_collection_param(opts[:'aids'], :csv) if !opts[:'aids'].nil?
  query_params[:'ffcids'] = @api_client.build_collection_param(opts[:'ffcids'], :csv) if !opts[:'ffcids'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'DomainQueriesResponseV1'

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

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

#search_collectors_v1(opts = {}) ⇒ DomainQueriesResponseV1

Search Collectors for the given Customer ID and Platform

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :platform (String) —

    Platform

  • :filter (String) —

    FQL filter

  • :limit (String) —

    Limit

  • :offset (String) —

    Offset

  • :sort (String) —

    Sort

Returns:



1483
1484
1485
1486
 
# File 'lib/crimson-falcon/api/default.rb', line 1483

def search_collectors_v1(opts = {})
  data, _status_code, _headers = search_collectors_v1_with_http_info(opts)
  data
end

#search_collectors_v1_with_http_info(opts = {}) ⇒ Array<(DomainQueriesResponseV1, Integer, Hash)>

Search Collectors for the given Customer ID and Platform

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :platform (String) —

    Platform

  • :filter (String) —

    FQL filter

  • :limit (String) —

    Limit

  • :offset (String) —

    Offset

  • :sort (String) —

    Sort

Returns:

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

    DomainQueriesResponseV1 data, response status code and response headers



1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
 
# File 'lib/crimson-falcon/api/default.rb', line 1496

def search_collectors_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.search_collectors_v1 ...'
  end
  allowable_values = ["windows", "linux", "mac"]
  if @api_client.config.client_side_validation && opts[:'platform'] && !allowable_values.include?(opts[:'platform'])
    fail ArgumentError, "invalid value for \"platform\", must be one of #{allowable_values}"
  end
  allowable_values = ["null", "aid|asc", "aid|desc", "ffcid|asc", "ffcid|desc", "platform|asc", "platform|desc", "modified_timestamp|asc", "modified_timestamp|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 = '/forensics/queries/collectors/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'DomainQueriesResponseV1'

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

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

#search_configs_v1(opts = {}) ⇒ DomainQueriesResponseV1

Search Configurations for the given Customer ID

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL filter

  • :limit (String) —

    Limit

  • :offset (String) —

    Offset

  • :sort (String) —

    Sort

Returns:



1560
1561
1562
1563
 
# File 'lib/crimson-falcon/api/default.rb', line 1560

def search_configs_v1(opts = {})
  data, _status_code, _headers = search_configs_v1_with_http_info(opts)
  data
end

#search_configs_v1_with_http_info(opts = {}) ⇒ Array<(DomainQueriesResponseV1, Integer, Hash)>

Search Configurations for the given Customer ID

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL filter

  • :limit (String) —

    Limit

  • :offset (String) —

    Offset

  • :sort (String) —

    Sort

Returns:

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

    DomainQueriesResponseV1 data, response status code and response headers



1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
 
# File 'lib/crimson-falcon/api/default.rb', line 1572

def search_configs_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.search_configs_v1 ...'
  end
  allowable_values = ["id|asc", "id|desc", "name|asc", "name|desc", "modified_timestamp|asc", "modified_timestamp|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 = '/forensics/queries/configurations/v1'

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

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

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

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

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

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

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

#search_templates_v1(opts = {}) ⇒ DomainQueriesResponseV1

Search Templates

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL filter

  • :limit (String) —

    Limit

  • :offset (String) —

    Offset

  • :sort (String) —

    Sort

Returns:



1631
1632
1633
1634
 
# File 'lib/crimson-falcon/api/default.rb', line 1631

def search_templates_v1(opts = {})
  data, _status_code, _headers = search_templates_v1_with_http_info(opts)
  data
end

#search_templates_v1_with_http_info(opts = {}) ⇒ Array<(DomainQueriesResponseV1, Integer, Hash)>

Search Templates

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    FQL filter

  • :limit (String) —

    Limit

  • :offset (String) —

    Offset

  • :sort (String) —

    Sort

Returns:

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

    DomainQueriesResponseV1 data, response status code and response headers



1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
 
# File 'lib/crimson-falcon/api/default.rb', line 1643

def search_templates_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.search_templates_v1 ...'
  end
  allowable_values = ["id|asc", "id|desc", "name|asc", "name|desc", "modified_timestamp|asc", "modified_timestamp|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 = '/forensics/queries/templates/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'DomainQueriesResponseV1'

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

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

#v1_host_configs_post(body, opts = {}) ⇒ PluginsonpremapiOnPremConfigureResponse

Configures all hosts in the provided host group to be ready to accept an execute API call

Parameters:

Returns:



1699
1700
1701
1702
 
# File 'lib/crimson-falcon/api/default.rb', line 1699

def v1_host_configs_post(body, opts = {})
  data, _status_code, _headers = v1_host_configs_post_with_http_info(body, opts)
  data
end

#v1_host_configs_post_with_http_info(body, opts = {}) ⇒ Array<(PluginsonpremapiOnPremConfigureResponse, Integer, Hash)>

Configures all hosts in the provided host group to be ready to accept an execute API call

Parameters:

Returns:



1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
 
# File 'lib/crimson-falcon/api/default.rb', line 1708

def v1_host_configs_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.v1_host_configs_post ...'
  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 Default.v1_host_configs_post"
  end
  # resource path
  local_var_path = '/pluginsonprem/entities/host-configs/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] || 'PluginsonpremapiOnPremConfigureResponse'

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

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

#v1_status_get(ids, opts = {}) ⇒ PluginsonpremapiOnPremGetHostConfigsResponse

Fetches the host configs within the provided host group.

Parameters:

  • ids (Array<String>) —

    ID of host group(s) to get configuration for.

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

    the optional parameters

Returns:



1765
1766
1767
1768
 
# File 'lib/crimson-falcon/api/default.rb', line 1765

def v1_status_get(ids, opts = {})
  data, _status_code, _headers = v1_status_get_with_http_info(ids, opts)
  data
end

#v1_status_get_with_http_info(ids, opts = {}) ⇒ Array<(PluginsonpremapiOnPremGetHostConfigsResponse, Integer, Hash)>

Fetches the host configs within the provided host group.

Parameters:

  • ids (Array<String>) —

    ID of host group(s) to get configuration for.

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

    the optional parameters

Returns:



1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
 
# File 'lib/crimson-falcon/api/default.rb', line 1774

def v1_status_get_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.v1_status_get ...'
  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 Default.v1_status_get"
  end
  # resource path
  local_var_path = '/pluginsonprem/entities/host-configs/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] || 'PluginsonpremapiOnPremGetHostConfigsResponse'

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

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

#validate_collection_v1(body, opts = {}) ⇒ DomainResponseV1

Validates a configuration collection

Parameters:

Returns:



1827
1828
1829
1830
 
# File 'lib/crimson-falcon/api/default.rb', line 1827

def validate_collection_v1(body, opts = {})
  data, _status_code, _headers = validate_collection_v1_with_http_info(body, opts)
  data
end

#validate_collection_v1_with_http_info(body, opts = {}) ⇒ Array<(DomainResponseV1, Integer, Hash)>

Validates a configuration collection

Parameters:

Returns:

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

    DomainResponseV1 data, response status code and response headers



1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
 
# File 'lib/crimson-falcon/api/default.rb', line 1836

def validate_collection_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.validate_collection_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 Default.validate_collection_v1"
  end
  # resource path
  local_var_path = '/forensics/entities/collections-validate/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', 'application/yaml'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/yaml'])
  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] || 'DomainResponseV1'

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

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

#validate_config_v1(body, opts = {}) ⇒ DomainResponseV1

Validates a custom configuration

Parameters:

Returns:



1893
1894
1895
1896
 
# File 'lib/crimson-falcon/api/default.rb', line 1893

def validate_config_v1(body, opts = {})
  data, _status_code, _headers = validate_config_v1_with_http_info(body, opts)
  data
end

#validate_config_v1_with_http_info(body, opts = {}) ⇒ Array<(DomainResponseV1, Integer, Hash)>

Validates a custom configuration

Parameters:

Returns:

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

    DomainResponseV1 data, response status code and response headers



1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
 
# File 'lib/crimson-falcon/api/default.rb', line 1902

def validate_config_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Default.validate_config_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 Default.validate_config_v1"
  end
  # resource path
  local_var_path = '/forensics/entities/configurations-validate/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', 'application/yaml'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/yaml'])
  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] || 'DomainResponseV1'

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

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