Class: Falcon::Intel

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Intel

Returns a new instance of Intel.



35
36
37
 
# File 'lib/crimson-falcon/api/intel.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/intel.rb', line 33

def api_client
  @api_client
end

Instance Method Details

#cao_incidents_aggregates_v1(body, opts = {}) ⇒ MsaAggregatesResponse

Perform statistical aggregations over incident data. Available aggregation properties: TargetCountries.Name, Id, InvolvesAdversaries.AnimalClassifier, TargetIndustries.Name, TargetRegions.Slug, MitreAttack.TacticName, MitreAttack.TechniqueId, MitreAttack.TechniqueName, TargetCountries.Slug, TargetRegions.Name, MitreAttack.TacticId, PublishDate, ActivityStart, ActivityEnd, Objectives.Slug, Motivations.Slug, InvolvesAdversaries.Slug, InvolvesThreats.FamilyName, TargetIndustries.Slug.

Parameters:

Returns:



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

def cao_incidents_aggregates_v1(body, opts = {})
  data, _status_code, _headers = cao_incidents_aggregates_v1_with_http_info(body, opts)
  data
end

#cao_incidents_aggregates_v1_with_http_info(body, opts = {}) ⇒ Array<(MsaAggregatesResponse, Integer, Hash)>

Perform statistical aggregations over incident data. Available aggregation properties: TargetCountries.Name, Id, InvolvesAdversaries.AnimalClassifier, TargetIndustries.Name, TargetRegions.Slug, MitreAttack.TacticName, MitreAttack.TechniqueId, MitreAttack.TechniqueName, TargetCountries.Slug, TargetRegions.Name, MitreAttack.TacticId, PublishDate, ActivityStart, ActivityEnd, Objectives.Slug, Motivations.Slug, InvolvesAdversaries.Slug, InvolvesThreats.FamilyName, TargetIndustries.Slug.

Parameters:

Returns:

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

    MsaAggregatesResponse data, response status code and response headers



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/crimson-falcon/api/intel.rb', line 51

def cao_incidents_aggregates_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.cao_incidents_aggregates_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 Intel.cao_incidents_aggregates_v1"
  end
  # resource path
  local_var_path = '/intel/aggregates/incidents/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] || 'MsaAggregatesResponse'

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

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

#cao_incidents_entities_v1(body, opts = {}) ⇒ IncidentResponseV1

Retrieve full details for one or more adversary incidents by their IDs. Returns complete incident data including adversary activity, timestamps, and associated metadata.

Parameters:

  • body (MsaIdsRequest) —

    List of incident IDs.

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

    the optional parameters

Returns:



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

def cao_incidents_entities_v1(body, opts = {})
  data, _status_code, _headers = cao_incidents_entities_v1_with_http_info(body, opts)
  data
end

#cao_incidents_entities_v1_with_http_info(body, opts = {}) ⇒ Array<(IncidentResponseV1, Integer, Hash)>

Retrieve full details for one or more adversary incidents by their IDs. Returns complete incident data including adversary activity, timestamps, and associated metadata.

Parameters:

  • body (MsaIdsRequest) —

    List of incident IDs.

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

    the optional parameters

Returns:

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

    IncidentResponseV1 data, response status code and response headers



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
162
163
164
165
166
167
168
 
# File 'lib/crimson-falcon/api/intel.rb', line 117

def cao_incidents_entities_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.cao_incidents_entities_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 Intel.cao_incidents_entities_v1"
  end
  # resource path
  local_var_path = '/intel/entities/incidents/GET/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] || 'IncidentResponseV1'

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

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

#cao_incidents_queries_v1(opts = {}) ⇒ MsaspecQueryResponse

Search for adversary incidents using FQL criteria and return a paginated list of matching incident IDs. Use the returned IDs with the entities endpoint to retrieve full incident details.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    The property to sort on, followed by a dot (.), followed by the sort direction, either &quot;asc&quot; or &quot;desc&quot;. Available sort properties: ActivityEnd, PublishDate, InvolvesAdversaries.Name, InvolvesAdversaries.Slug, LastModifiedAt, ActivityStart.

  • :filter (String) —

    Optional filter and sort criteria in the form of an FQL query. For more information about FQL queries, see [our FQL documentation in Falcon](falcon.crowdstrike.com/support/documentation/45/falcon-query-language-feature-guide). Available filters: ReferencesNotableEvents.Title, InvolvesIndicators.Value, LastModifiedAt, ActivityEnd, InvolvesAdversaries.Slug, MitreAttack.TacticId, All, Title, ActivityStart, InvolvesAdversaries.Name, InvolvesAdversaries.AnimalClassifier, TargetsVulnerabilities.CVE, Motivations.Slug, TargetingProfile.Slug, PublishDate, InvolvesThreats.FamilyName, MitreAttack.Id, MitreAttack.TacticName, MitreAttack.TechniqueId, TargetCountries.Slug, TargetRegions.Slug, TargetIndustries.Slug, Id, InvolvesAdversaries.Id, Objectives.Slug, MitreAttack.TechniqueName. &#39;All&#39; can be used for text queries on all attributes.

  • :limit (Integer) —

    The maximum records to return. Cannot be higher than 200.

  • :offset (String) —

    Starting index of overall result set from which to return ids.

Returns:



177
178
179
180
 
# File 'lib/crimson-falcon/api/intel.rb', line 177

def cao_incidents_queries_v1(opts = {})
  data, _status_code, _headers = cao_incidents_queries_v1_with_http_info(opts)
  data
end

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

Search for adversary incidents using FQL criteria and return a paginated list of matching incident IDs. Use the returned IDs with the entities endpoint to retrieve full incident details.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :sort (String) —

    The property to sort on, followed by a dot (.), followed by the sort direction, either &quot;asc&quot; or &quot;desc&quot;. Available sort properties: ActivityEnd, PublishDate, InvolvesAdversaries.Name, InvolvesAdversaries.Slug, LastModifiedAt, ActivityStart.

  • :filter (String) —

    Optional filter and sort criteria in the form of an FQL query. For more information about FQL queries, see [our FQL documentation in Falcon](falcon.crowdstrike.com/support/documentation/45/falcon-query-language-feature-guide). Available filters: ReferencesNotableEvents.Title, InvolvesIndicators.Value, LastModifiedAt, ActivityEnd, InvolvesAdversaries.Slug, MitreAttack.TacticId, All, Title, ActivityStart, InvolvesAdversaries.Name, InvolvesAdversaries.AnimalClassifier, TargetsVulnerabilities.CVE, Motivations.Slug, TargetingProfile.Slug, PublishDate, InvolvesThreats.FamilyName, MitreAttack.Id, MitreAttack.TacticName, MitreAttack.TechniqueId, TargetCountries.Slug, TargetRegions.Slug, TargetIndustries.Slug, Id, InvolvesAdversaries.Id, Objectives.Slug, MitreAttack.TechniqueName. &#39;All&#39; can be used for text queries on all attributes.

  • :limit (Integer) —

    The maximum records to return. Cannot be higher than 200.

  • :offset (String) —

    Starting index of overall result set from which to return ids.

Returns:

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

    MsaspecQueryResponse data, response status code and response headers



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
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/crimson-falcon/api/intel.rb', line 189

def cao_incidents_queries_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.cao_incidents_queries_v1 ...'
  end
  # resource path
  local_var_path = '/intel/queries/incidents/v1'

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

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

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

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

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

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

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

#get_intel_actor_entities(ids, opts = {}) ⇒ DomainActorsResponse

Retrieve specific actors using their actor IDs.

Parameters:

  • ids (Array<String>) —

    The IDs of the actors you want to retrieve.

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    The fields to return, or a predefined set of fields in the form of the collection name surrounded by two underscores like: __\&lt;collection\&gt;__. Ex: slug _full_. Defaults to _basic_.

Returns:



242
243
244
245
 
# File 'lib/crimson-falcon/api/intel.rb', line 242

def get_intel_actor_entities(ids, opts = {})
  data, _status_code, _headers = get_intel_actor_entities_with_http_info(ids, opts)
  data
end

#get_intel_actor_entities_with_http_info(ids, opts = {}) ⇒ Array<(DomainActorsResponse, Integer, Hash)>

Retrieve specific actors using their actor IDs.

Parameters:

  • ids (Array<String>) —

    The IDs of the actors you want to retrieve.

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    The fields to return, or a predefined set of fields in the form of the collection name surrounded by two underscores like: __\&lt;collection\&gt;__. Ex: slug _full_. Defaults to _basic_.

Returns:

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

    DomainActorsResponse data, response status code and response headers



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
295
296
297
298
299
300
 
# File 'lib/crimson-falcon/api/intel.rb', line 252

def get_intel_actor_entities_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.get_intel_actor_entities ...'
  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 Intel.get_intel_actor_entities"
  end
  # resource path
  local_var_path = '/intel/entities/actors/v1'

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

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

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

#get_intel_indicator_entities(body, opts = {}) ⇒ DomainPublicIndicatorsV3Response

Retrieve specific indicators using their indicator IDs.

Parameters:

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

    the optional parameters

Returns:



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

def get_intel_indicator_entities(body, opts = {})
  data, _status_code, _headers = get_intel_indicator_entities_with_http_info(body, opts)
  data
end

#get_intel_indicator_entities_with_http_info(body, opts = {}) ⇒ Array<(DomainPublicIndicatorsV3Response, Integer, Hash)>

Retrieve specific indicators using their indicator IDs.

Parameters:

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

    the optional parameters

Returns:



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/crimson-falcon/api/intel.rb', line 315

def get_intel_indicator_entities_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.get_intel_indicator_entities ...'
  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 Intel.get_intel_indicator_entities"
  end
  # resource path
  local_var_path = '/intel/entities/indicators/GET/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] || 'DomainPublicIndicatorsV3Response'

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

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

#get_intel_report_entities(ids, opts = {}) ⇒ DomainNewsResponse

Retrieve specific reports using their report IDs.

Parameters:

  • ids (Array<String>) —

    The IDs of the reports you want to retrieve.

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    The fields to return, or a predefined set of fields in the form of the collection name surrounded by two underscores like: __\&lt;collection\&gt;__. Ex: slug _full_. Defaults to _basic_.

Returns:



373
374
375
376
 
# File 'lib/crimson-falcon/api/intel.rb', line 373

def get_intel_report_entities(ids, opts = {})
  data, _status_code, _headers = get_intel_report_entities_with_http_info(ids, opts)
  data
end

#get_intel_report_entities_with_http_info(ids, opts = {}) ⇒ Array<(DomainNewsResponse, Integer, Hash)>

Retrieve specific reports using their report IDs.

Parameters:

  • ids (Array<String>) —

    The IDs of the reports you want to retrieve.

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    The fields to return, or a predefined set of fields in the form of the collection name surrounded by two underscores like: __\&lt;collection\&gt;__. Ex: slug _full_. Defaults to _basic_.

Returns:

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

    DomainNewsResponse data, response status code and response headers



383
384
385
386
387
388
389
390
391
392
393
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
 
# File 'lib/crimson-falcon/api/intel.rb', line 383

def get_intel_report_entities_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.get_intel_report_entities ...'
  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 Intel.get_intel_report_entities"
  end
  # resource path
  local_var_path = '/intel/entities/reports/v1'

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

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

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

#get_intel_report_pdf(opts = {}) ⇒ File

Return a Report PDF attachment

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    The ID of the report you want to download as a PDF.

  • :ids (String) —

    The ID of the report you want to download as a PDF. This parameter is used only if no id parameter given.

Returns:

  • (File) 


438
439
440
441
 
# File 'lib/crimson-falcon/api/intel.rb', line 438

def get_intel_report_pdf(opts = {})
  data, _status_code, _headers = get_intel_report_pdf_with_http_info(opts)
  data
end

#get_intel_report_pdf_with_http_info(opts = {}) ⇒ Array<(File, Integer, Hash)>

Return a Report PDF attachment

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    The ID of the report you want to download as a PDF.

  • :ids (String) —

    The ID of the report you want to download as a PDF. This parameter is used only if no id parameter given.

Returns:

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

    File data, response status code and response headers



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
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/crimson-falcon/api/intel.rb', line 448

def get_intel_report_pdf_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.get_intel_report_pdf ...'
  end
  # resource path
  local_var_path = '/intel/entities/report-files/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'ids'] = opts[:'ids'] 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/octet-stream', 'application/json', 'application/pdf'])

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

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

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

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

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

#get_intel_rule_entities(ids, opts = {}) ⇒ DomainRulesResponse

Retrieve details for rule sets for the specified ids.

Parameters:

  • ids (Array<String>) —

    The ids of rules to return.

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

    the optional parameters

Returns:



498
499
500
501
 
# File 'lib/crimson-falcon/api/intel.rb', line 498

def get_intel_rule_entities(ids, opts = {})
  data, _status_code, _headers = get_intel_rule_entities_with_http_info(ids, opts)
  data
end

#get_intel_rule_entities_with_http_info(ids, opts = {}) ⇒ Array<(DomainRulesResponse, Integer, Hash)>

Retrieve details for rule sets for the specified ids.

Parameters:

  • ids (Array<String>) —

    The ids of rules to return.

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

    the optional parameters

Returns:

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

    DomainRulesResponse data, response status code and response headers



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
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/crimson-falcon/api/intel.rb', line 507

def get_intel_rule_entities_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.get_intel_rule_entities ...'
  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 Intel.get_intel_rule_entities"
  end
  # resource path
  local_var_path = '/intel/entities/rules/v1'

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

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

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

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

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

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

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

#get_intel_rule_file(id, opts = {}) ⇒ File

Download earlier rule sets.

Parameters:

  • id (Integer) —

    The ID of the rule set.

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

    the optional parameters

Options Hash (opts):

  • :accept (String) —

    Choose the format you want the rule set in.

  • :format (String) —

    Choose the format you want the rule set in. Valid formats are zip and gzip. Defaults to zip.

Returns:

  • (File) 


562
563
564
565
 
# File 'lib/crimson-falcon/api/intel.rb', line 562

def get_intel_rule_file(id, opts = {})
  data, _status_code, _headers = get_intel_rule_file_with_http_info(id, opts)
  data
end

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

Download earlier rule sets.

Parameters:

  • id (Integer) —

    The ID of the rule set.

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

    the optional parameters

Options Hash (opts):

  • :accept (String) —

    Choose the format you want the rule set in.

  • :format (String) —

    Choose the format you want the rule set in. Valid formats are zip and gzip. Defaults to zip.

Returns:

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

    File data, response status code and response headers



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
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'lib/crimson-falcon/api/intel.rb', line 573

def get_intel_rule_file_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.get_intel_rule_file ...'
  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 Intel.get_intel_rule_file"
  end
  # resource path
  local_var_path = '/intel/entities/rules-files/v1'

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

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

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

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

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

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

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

#get_latest_intel_rule_file(type, opts = {}) ⇒ File

Download the latest rule set.

Parameters:

  • type (String) —

    The rule news report type. Accepted values: snort-suricata-master snort-suricata-update snort-suricata-changelog yara-master yara-update yara-changelog common-event-format netwitness cql-master cql-update cql-changelog

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

    the optional parameters

Options Hash (opts):

  • :accept (String) —

    Choose the format you want the rule set in.

  • :if_none_match (String) —

    Download the latest rule set only if it doesn&#39;t have an ETag matching the given ones.

  • :if_modified_since (String) —

    Download the latest rule set only if the rule was modified after this date. http, ANSIC and RFC850 formats accepted

  • :format (String) —

    Choose the format you want the rule set in. Valid formats are zip and gzip. Defaults to zip.

  • :if_modified_since2 (String) —

    Download Only if changed since

Returns:

  • (File) 


633
634
635
636
 
# File 'lib/crimson-falcon/api/intel.rb', line 633

def get_latest_intel_rule_file(type, opts = {})
  data, _status_code, _headers = get_latest_intel_rule_file_with_http_info(type, opts)
  data
end

#get_latest_intel_rule_file_with_http_info(type, opts = {}) ⇒ Array<(File, Integer, Hash)>

Download the latest rule set.

Parameters:

  • type (String) —

    The rule news report type. Accepted values: snort-suricata-master snort-suricata-update snort-suricata-changelog yara-master yara-update yara-changelog common-event-format netwitness cql-master cql-update cql-changelog

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

    the optional parameters

Options Hash (opts):

  • :accept (String) —

    Choose the format you want the rule set in.

  • :if_none_match (String) —

    Download the latest rule set only if it doesn&#39;t have an ETag matching the given ones.

  • :if_modified_since (String) —

    Download the latest rule set only if the rule was modified after this date. http, ANSIC and RFC850 formats accepted

  • :format (String) —

    Choose the format you want the rule set in. Valid formats are zip and gzip. Defaults to zip.

  • :if_modified_since2 (String) —

    Download Only if changed since

Returns:

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

    File data, response status code and response headers



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

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/zip', 'application/gzip', 'application/octet-stream', 'application/json', '*/*'])
  header_params[:'Accept'] = opts[:'accept'] if !opts[:'accept'].nil?
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since2'] if !opts[:'if_modified_since2'].nil?

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

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

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

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

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

#get_malware_entities(ids, opts = {}) ⇒ DomainMalwareResponse

Get malware entities for specified ids.

Parameters:

  • ids (Array<String>) —

    Malware family name in lower case with spaces, dots and slashes replaced with dashes

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

    the optional parameters

Returns:



705
706
707
708
 
# File 'lib/crimson-falcon/api/intel.rb', line 705

def get_malware_entities(ids, opts = {})
  data, _status_code, _headers = get_malware_entities_with_http_info(ids, opts)
  data
end

#get_malware_entities_with_http_info(ids, opts = {}) ⇒ Array<(DomainMalwareResponse, Integer, Hash)>

Get malware entities for specified ids.

Parameters:

  • ids (Array<String>) —

    Malware family name in lower case with spaces, dots and slashes replaced with dashes

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

    the optional parameters

Returns:

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

    DomainMalwareResponse data, response status code and response headers



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

def get_malware_entities_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.get_malware_entities ...'
  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 Intel.get_malware_entities"
  end
  # resource path
  local_var_path = '/intel/entities/malware/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] || 'DomainMalwareResponse'

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

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

#get_malware_mitre_report(id, format, opts = {}) ⇒ nil

Export Mitre ATT&CK information for a given malware family.

Parameters:

  • id (String) —

    Malware family name in lower case with spaces replaced with dashes

  • format (String) —

    Supported report formats: CSV, JSON or JSON_NAVIGATOR

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

    the optional parameters

Options Hash (opts):

  • :x_cs_useruuid (String) —

    User id

Returns:

  • (nil) 


769
770
771
772
 
# File 'lib/crimson-falcon/api/intel.rb', line 769

def get_malware_mitre_report(id, format, opts = {})
  get_malware_mitre_report_with_http_info(id, format, opts)
  nil
end

#get_malware_mitre_report_with_http_info(id, format, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Export Mitre ATT&amp;CK information for a given malware family.

Parameters:

  • id (String) —

    Malware family name in lower case with spaces replaced with dashes

  • format (String) —

    Supported report formats: CSV, JSON or JSON_NAVIGATOR

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

    the optional parameters

Options Hash (opts):

  • :x_cs_useruuid (String) —

    User id

Returns:

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

    nil, response status code and response headers



780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
 
# File 'lib/crimson-falcon/api/intel.rb', line 780

def get_malware_mitre_report_with_http_info(id, format, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.get_malware_mitre_report ...'
  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 Intel.get_malware_mitre_report"
  end
  # verify the required parameter 'format' is set
  if @api_client.config.client_side_validation && format.nil?
    fail ArgumentError, "Missing the required parameter 'format' when calling Intel.get_malware_mitre_report"
  end
  # resource path
  local_var_path = '/intel/entities/malware-mitre-reports/v1'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv'])
  header_params[:'X-CS-USERUUID'] = opts[:'x_cs_useruuid'] if !opts[:'x_cs_useruuid'].nil?

  # 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 => :"Intel.get_malware_mitre_report",
    :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: Intel#get_malware_mitre_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_mitre_report(actor_id, format, opts = {}) ⇒ nil

Export Mitre ATT&CK information for a given actor.

Parameters:

  • actor_id (String) —

    Actor ID(derived from the actor&#39;s name)

  • format (String) —

    Supported report formats: CSV or JSON

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

    the optional parameters

Returns:

  • (nil) 


840
841
842
843
 
# File 'lib/crimson-falcon/api/intel.rb', line 840

def get_mitre_report(actor_id, format, opts = {})
  get_mitre_report_with_http_info(actor_id, format, opts)
  nil
end

#get_mitre_report_with_http_info(actor_id, format, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Export Mitre ATT&amp;CK information for a given actor.

Parameters:

  • actor_id (String) —

    Actor ID(derived from the actor&#39;s name)

  • format (String) —

    Supported report formats: CSV or JSON

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
 
# File 'lib/crimson-falcon/api/intel.rb', line 850

def get_mitre_report_with_http_info(actor_id, format, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.get_mitre_report ...'
  end
  # verify the required parameter 'actor_id' is set
  if @api_client.config.client_side_validation && actor_id.nil?
    fail ArgumentError, "Missing the required parameter 'actor_id' when calling Intel.get_mitre_report"
  end
  # verify the required parameter 'format' is set
  if @api_client.config.client_side_validation && format.nil?
    fail ArgumentError, "Missing the required parameter 'format' when calling Intel.get_mitre_report"
  end
  # resource path
  local_var_path = '/intel/entities/mitre-reports/v1'

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

  # 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', 'text/csv'])

  # 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 => :"Intel.get_mitre_report",
    :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: Intel#get_mitre_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_vulnerabilities(body, opts = {}) ⇒ DomainVulnerabilityResponse

Get vulnerabilities

Parameters:

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

    the optional parameters

Returns:



908
909
910
911
 
# File 'lib/crimson-falcon/api/intel.rb', line 908

def get_vulnerabilities(body, opts = {})
  data, _status_code, _headers = get_vulnerabilities_with_http_info(body, opts)
  data
end

#get_vulnerabilities_with_http_info(body, opts = {}) ⇒ Array<(DomainVulnerabilityResponse, Integer, Hash)>

Get vulnerabilities

Parameters:

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

    the optional parameters

Returns:

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

    DomainVulnerabilityResponse data, response status code and response headers



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

def get_vulnerabilities_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.get_vulnerabilities ...'
  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 Intel.get_vulnerabilities"
  end
  # resource path
  local_var_path = '/intel/entities/vulnerabilities/GET/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] || 'DomainVulnerabilityResponse'

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

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

#post_mitre_attacks(body, opts = {}) ⇒ nil

Retrieves report and observable IDs associated with the given actor and attacks

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


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

def post_mitre_attacks(body, opts = {})
  post_mitre_attacks_with_http_info(body, opts)
  nil
end

#post_mitre_attacks_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Retrieves report and observable IDs associated with the given actor and attacks

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def post_mitre_attacks_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.post_mitre_attacks ...'
  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 Intel.post_mitre_attacks"
  end
  # resource path
  local_var_path = '/intel/entities/mitre/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]

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

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

#query_intel_actor_entities(opts = {}) ⇒ DomainActorsResponse

Get info about actors that match provided FQL filters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Set the starting row number to return actors from. Defaults to 0.

  • :limit (Integer) —

    Set the number of actors to return. The value must be between 1 and 5000.

  • :sort (String) —

    Order fields in ascending or descending order. Ex: created_date|asc.

  • :filter (String) —

    Filter your query by specifying FQL filter parameters. Filter parameters include: actor_type, animal_classifier, capabilities, capability, capability.id, capability.slug, capability.value, created_date, description, ecrime_kill_chain.attribution, ecrime_kill_chain.crimes, ecrime_kill_chain.customers, ecrime_kill_chain.marketing, ecrime_kill_chain.monetization, ecrime_kill_chain.services_offered, ecrime_kill_chain.services_used, ecrime_kill_chain.technical_tradecraft, ecrime_kill_chain.victims, first_activity_date, group, group.id, group.slug, group.value, id, kill_chain.actions_and_objectives, kill_chain.actions_on_objectives, kill_chain.command_and_control, kill_chain.delivery, kill_chain.exploitation, kill_chain.installation, kill_chain.objectives, kill_chain.reconnaissance, kill_chain.weaponization, known_as, last_activity_date, last_modified_date, motivations, motivations.id, motivations.slug, motivations.value, name, objectives, origins, origins.id, origins.slug, origins.value, region, region.id, region.slug, region.value, short_description, slug, status, target_countries, target_countries.id, target_countries.slug, target_countries.value, target_industries, target_industries.id, target_industries.slug, target_industries.value, target_regions, target_regions.id, target_regions.slug, target_regions.value.

  • :q (String) —

    Perform a generic substring search across all fields.

  • :fields (Array<String>) —

    The fields to return, or a predefined set of fields in the form of the collection name surrounded by two underscores like: __\&lt;collection\&gt;__. Ex: slug _full_. Defaults to _basic_.

Returns:



1045
1046
1047
1048
 
# File 'lib/crimson-falcon/api/intel.rb', line 1045

def query_intel_actor_entities(opts = {})
  data, _status_code, _headers = query_intel_actor_entities_with_http_info(opts)
  data
end

#query_intel_actor_entities_with_http_info(opts = {}) ⇒ Array<(DomainActorsResponse, Integer, Hash)>

Get info about actors that match provided FQL filters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Set the starting row number to return actors from. Defaults to 0.

  • :limit (Integer) —

    Set the number of actors to return. The value must be between 1 and 5000.

  • :sort (String) —

    Order fields in ascending or descending order. Ex: created_date|asc.

  • :filter (String) —

    Filter your query by specifying FQL filter parameters. Filter parameters include: actor_type, animal_classifier, capabilities, capability, capability.id, capability.slug, capability.value, created_date, description, ecrime_kill_chain.attribution, ecrime_kill_chain.crimes, ecrime_kill_chain.customers, ecrime_kill_chain.marketing, ecrime_kill_chain.monetization, ecrime_kill_chain.services_offered, ecrime_kill_chain.services_used, ecrime_kill_chain.technical_tradecraft, ecrime_kill_chain.victims, first_activity_date, group, group.id, group.slug, group.value, id, kill_chain.actions_and_objectives, kill_chain.actions_on_objectives, kill_chain.command_and_control, kill_chain.delivery, kill_chain.exploitation, kill_chain.installation, kill_chain.objectives, kill_chain.reconnaissance, kill_chain.weaponization, known_as, last_activity_date, last_modified_date, motivations, motivations.id, motivations.slug, motivations.value, name, objectives, origins, origins.id, origins.slug, origins.value, region, region.id, region.slug, region.value, short_description, slug, status, target_countries, target_countries.id, target_countries.slug, target_countries.value, target_industries, target_industries.id, target_industries.slug, target_industries.value, target_regions, target_regions.id, target_regions.slug, target_regions.value.

  • :q (String) —

    Perform a generic substring search across all fields.

  • :fields (Array<String>) —

    The fields to return, or a predefined set of fields in the form of the collection name surrounded by two underscores like: __\&lt;collection\&gt;__. Ex: slug _full_. Defaults to _basic_.

Returns:

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

    DomainActorsResponse data, response status code and response headers



1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
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
 
# File 'lib/crimson-falcon/api/intel.rb', line 1059

def query_intel_actor_entities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.query_intel_actor_entities ...'
  end
  # resource path
  local_var_path = '/intel/combined/actors/v1'

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

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

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

#query_intel_actor_ids(opts = {}) ⇒ MsaQueryResponse

Get actor IDs that match provided FQL filters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Set the starting row number to return actors IDs from. Defaults to 0.

  • :limit (Integer) —

    Set the number of actor IDs to return. The value must be between 1 and 5000.

  • :sort (String) —

    Order fields in ascending or descending order. Ex: created_date|asc.

  • :filter (String) —

    Filter your query by specifying FQL filter parameters. Filter parameters include: actor_type, animal_classifier, capabilities, capability, capability.id, capability.slug, capability.value, created_date, description, ecrime_kill_chain.attribution, ecrime_kill_chain.crimes, ecrime_kill_chain.customers, ecrime_kill_chain.marketing, ecrime_kill_chain.monetization, ecrime_kill_chain.services_offered, ecrime_kill_chain.services_used, ecrime_kill_chain.technical_tradecraft, ecrime_kill_chain.victims, first_activity_date, group, group.id, group.slug, group.value, id, kill_chain.actions_and_objectives, kill_chain.actions_on_objectives, kill_chain.command_and_control, kill_chain.delivery, kill_chain.exploitation, kill_chain.installation, kill_chain.objectives, kill_chain.reconnaissance, kill_chain.weaponization, known_as, last_activity_date, last_modified_date, motivations, motivations.id, motivations.slug, motivations.value, name, objectives, origins, origins.id, origins.slug, origins.value, region, region.id, region.slug, region.value, short_description, slug, status, target_countries, target_countries.id, target_countries.slug, target_countries.value, target_industries, target_industries.id, target_industries.slug, target_industries.value, target_regions, target_regions.id, target_regions.slug, target_regions.value.

  • :q (String) —

    Perform a generic substring search across all fields.

Returns:



1117
1118
1119
1120
 
# File 'lib/crimson-falcon/api/intel.rb', line 1117

def query_intel_actor_ids(opts = {})
  data, _status_code, _headers = query_intel_actor_ids_with_http_info(opts)
  data
end

#query_intel_actor_ids_with_http_info(opts = {}) ⇒ Array<(MsaQueryResponse, Integer, Hash)>

Get actor IDs that match provided FQL filters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Set the starting row number to return actors IDs from. Defaults to 0.

  • :limit (Integer) —

    Set the number of actor IDs to return. The value must be between 1 and 5000.

  • :sort (String) —

    Order fields in ascending or descending order. Ex: created_date|asc.

  • :filter (String) —

    Filter your query by specifying FQL filter parameters. Filter parameters include: actor_type, animal_classifier, capabilities, capability, capability.id, capability.slug, capability.value, created_date, description, ecrime_kill_chain.attribution, ecrime_kill_chain.crimes, ecrime_kill_chain.customers, ecrime_kill_chain.marketing, ecrime_kill_chain.monetization, ecrime_kill_chain.services_offered, ecrime_kill_chain.services_used, ecrime_kill_chain.technical_tradecraft, ecrime_kill_chain.victims, first_activity_date, group, group.id, group.slug, group.value, id, kill_chain.actions_and_objectives, kill_chain.actions_on_objectives, kill_chain.command_and_control, kill_chain.delivery, kill_chain.exploitation, kill_chain.installation, kill_chain.objectives, kill_chain.reconnaissance, kill_chain.weaponization, known_as, last_activity_date, last_modified_date, motivations, motivations.id, motivations.slug, motivations.value, name, objectives, origins, origins.id, origins.slug, origins.value, region, region.id, region.slug, region.value, short_description, slug, status, target_countries, target_countries.id, target_countries.slug, target_countries.value, target_industries, target_industries.id, target_industries.slug, target_industries.value, target_regions, target_regions.id, target_regions.slug, target_regions.value.

  • :q (String) —

    Perform a generic substring search across all fields.

Returns:

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

    MsaQueryResponse data, response status code and response headers



1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
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
 
# File 'lib/crimson-falcon/api/intel.rb', line 1130

def query_intel_actor_ids_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.query_intel_actor_ids ...'
  end
  # resource path
  local_var_path = '/intel/queries/actors/v1'

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

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

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

#query_intel_indicator_entities(opts = {}) ⇒ DomainPublicIndicatorsV3Response

Get info about indicators that match provided FQL filters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Set the starting row number to return indicators from. Defaults to 0.

  • :limit (Integer) —

    Set the number of indicators to return. The number must be between 1 and 10000

  • :sort (String) —

    Order fields in ascending or descending order. Ex: published_date|asc.

  • :filter (String) —

    Filter your query by specifying FQL filter parameters. Filter parameters include: _marker, actors, deleted, domain_types, id, indicator, ip_address_types, kill_chains, labels, labels.created_on, labels.last_valid_on, labels.name, last_updated, malicious_confidence, malware_families, published_date, reports, reports.slug, scope, targets, threat_types, type, vulnerabilities.

  • :q (String) —

    Perform a generic substring search across all fields.

  • :include_deleted (Boolean) —

    If true, include both published and deleted indicators in the response. Defaults to false.

  • :include_relations (Boolean) —

    If true, include related indicators in the response. Defaults to true.

Returns:



1189
1190
1191
1192
 
# File 'lib/crimson-falcon/api/intel.rb', line 1189

def query_intel_indicator_entities(opts = {})
  data, _status_code, _headers = query_intel_indicator_entities_with_http_info(opts)
  data
end

#query_intel_indicator_entities_with_http_info(opts = {}) ⇒ Array<(DomainPublicIndicatorsV3Response, Integer, Hash)>

Get info about indicators that match provided FQL filters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Set the starting row number to return indicators from. Defaults to 0.

  • :limit (Integer) —

    Set the number of indicators to return. The number must be between 1 and 10000

  • :sort (String) —

    Order fields in ascending or descending order. Ex: published_date|asc.

  • :filter (String) —

    Filter your query by specifying FQL filter parameters. Filter parameters include: _marker, actors, deleted, domain_types, id, indicator, ip_address_types, kill_chains, labels, labels.created_on, labels.last_valid_on, labels.name, last_updated, malicious_confidence, malware_families, published_date, reports, reports.slug, scope, targets, threat_types, type, vulnerabilities.

  • :q (String) —

    Perform a generic substring search across all fields.

  • :include_deleted (Boolean) —

    If true, include both published and deleted indicators in the response. Defaults to false.

  • :include_relations (Boolean) —

    If true, include related indicators in the response. Defaults to true.

Returns:



1204
1205
1206
1207
1208
1209
1210
1211
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
 
# File 'lib/crimson-falcon/api/intel.rb', line 1204

def query_intel_indicator_entities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.query_intel_indicator_entities ...'
  end
  # resource path
  local_var_path = '/intel/combined/indicators/v1'

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

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

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

#query_intel_indicator_ids(opts = {}) ⇒ MsaQueryResponse

Get indicators IDs that match provided FQL filters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Set the starting row number to return indicator IDs from. Defaults to 0.

  • :limit (Integer) —

    Set the number of indicator IDs to return. The number must be between 1 and 10000

  • :sort (String) —

    Order fields in ascending or descending order. Ex: published_date|asc.

  • :filter (String) —

    Filter your query by specifying FQL filter parameters. Filter parameters include: _marker, actors, deleted, domain_types, id, indicator, ip_address_types, kill_chains, labels, labels.created_on, labels.last_valid_on, labels.name, last_updated, malicious_confidence, malware_families, published_date, reports, reports.slug, scope, targets, threat_types, type, vulnerabilities.

  • :q (String) —

    Perform a generic substring search across all fields.

  • :include_deleted (Boolean) —

    If true, include both published and deleted indicators in the response. Defaults to false.

  • :include_relations (Boolean) —

    If true, include related indicators in the response. Defaults to true.

Returns:



1265
1266
1267
1268
 
# File 'lib/crimson-falcon/api/intel.rb', line 1265

def query_intel_indicator_ids(opts = {})
  data, _status_code, _headers = query_intel_indicator_ids_with_http_info(opts)
  data
end

#query_intel_indicator_ids_with_http_info(opts = {}) ⇒ Array<(MsaQueryResponse, Integer, Hash)>

Get indicators IDs that match provided FQL filters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Set the starting row number to return indicator IDs from. Defaults to 0.

  • :limit (Integer) —

    Set the number of indicator IDs to return. The number must be between 1 and 10000

  • :sort (String) —

    Order fields in ascending or descending order. Ex: published_date|asc.

  • :filter (String) —

    Filter your query by specifying FQL filter parameters. Filter parameters include: _marker, actors, deleted, domain_types, id, indicator, ip_address_types, kill_chains, labels, labels.created_on, labels.last_valid_on, labels.name, last_updated, malicious_confidence, malware_families, published_date, reports, reports.slug, scope, targets, threat_types, type, vulnerabilities.

  • :q (String) —

    Perform a generic substring search across all fields.

  • :include_deleted (Boolean) —

    If true, include both published and deleted indicators in the response. Defaults to false.

  • :include_relations (Boolean) —

    If true, include related indicators in the response. Defaults to true.

Returns:

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

    MsaQueryResponse data, response status code and response headers



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
1321
1322
1323
1324
1325
1326
1327
1328
1329
 
# File 'lib/crimson-falcon/api/intel.rb', line 1280

def query_intel_indicator_ids_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.query_intel_indicator_ids ...'
  end
  # resource path
  local_var_path = '/intel/queries/indicators/v1'

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

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

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

#query_intel_report_entities(opts = {}) ⇒ DomainNewsResponse

Get info about reports that match provided FQL filters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Set the starting row number to return reports from. Defaults to 0.

  • :limit (Integer) —

    Set the number of reports to return. The value must be between 1 and 5000.

  • :sort (String) —

    Order fields in ascending or descending order. Ex: created_date|asc.

  • :filter (String) —

    Filter your query by specifying FQL filter parameters. Filter parameters include: actors, actors.animal_classifier, actors.id, actors.name, actors.slug, actors.url, created_date, description, id, last_modified_date, malware, malware.community_identifiers, malware.family_name, malware.slug, motivations, motivations.id, motivations.slug, motivations.value, name, name.raw, short_description, slug, sub_type, sub_type.id, sub_type.name, sub_type.slug, summary, tags, tags.id, tags.slug, tags.value, target_countries, target_countries.id, target_countries.slug, target_countries.value, target_industries, target_industries.id, target_industries.slug, target_industries.value, type, type.id, type.name, type.slug, url.

  • :q (String) —

    Perform a generic substring search across all fields.

  • :fields (Array<String>) —

    The fields to return, or a predefined set of fields in the form of the collection name surrounded by two underscores like: __\&lt;collection\&gt;__. Ex: slug _full_. Defaults to _basic_.

Returns:



1340
1341
1342
1343
 
# File 'lib/crimson-falcon/api/intel.rb', line 1340

def query_intel_report_entities(opts = {})
  data, _status_code, _headers = query_intel_report_entities_with_http_info(opts)
  data
end

#query_intel_report_entities_with_http_info(opts = {}) ⇒ Array<(DomainNewsResponse, Integer, Hash)>

Get info about reports that match provided FQL filters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Set the starting row number to return reports from. Defaults to 0.

  • :limit (Integer) —

    Set the number of reports to return. The value must be between 1 and 5000.

  • :sort (String) —

    Order fields in ascending or descending order. Ex: created_date|asc.

  • :filter (String) —

    Filter your query by specifying FQL filter parameters. Filter parameters include: actors, actors.animal_classifier, actors.id, actors.name, actors.slug, actors.url, created_date, description, id, last_modified_date, malware, malware.community_identifiers, malware.family_name, malware.slug, motivations, motivations.id, motivations.slug, motivations.value, name, name.raw, short_description, slug, sub_type, sub_type.id, sub_type.name, sub_type.slug, summary, tags, tags.id, tags.slug, tags.value, target_countries, target_countries.id, target_countries.slug, target_countries.value, target_industries, target_industries.id, target_industries.slug, target_industries.value, type, type.id, type.name, type.slug, url.

  • :q (String) —

    Perform a generic substring search across all fields.

  • :fields (Array<String>) —

    The fields to return, or a predefined set of fields in the form of the collection name surrounded by two underscores like: __\&lt;collection\&gt;__. Ex: slug _full_. Defaults to _basic_.

Returns:

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

    DomainNewsResponse data, response status code and response headers



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
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
 
# File 'lib/crimson-falcon/api/intel.rb', line 1354

def query_intel_report_entities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.query_intel_report_entities ...'
  end
  # resource path
  local_var_path = '/intel/combined/reports/v1'

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

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

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

#query_intel_report_ids(opts = {}) ⇒ MsaQueryResponse

Get report IDs that match provided FQL filters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Set the starting row number to return report IDs from. Defaults to 0.

  • :limit (Integer) —

    Set the number of report IDs to return. The value must be between 1 and 5000.

  • :sort (String) —

    Order fields in ascending or descending order. Ex: created_date|asc.

  • :filter (String) —

    Filter your query by specifying FQL filter parameters. Filter parameters include: actors, actors.animal_classifier, actors.id, actors.name, actors.slug, actors.url, created_date, description, id, last_modified_date, malware, malware.community_identifiers, malware.family_name, malware.slug, motivations, motivations.id, motivations.slug, motivations.value, name, name.raw, short_description, slug, sub_type, sub_type.id, sub_type.name, sub_type.slug, summary, tags, tags.id, tags.slug, tags.value, target_countries, target_countries.id, target_countries.slug, target_countries.value, target_industries, target_industries.id, target_industries.slug, target_industries.value, type, type.id, type.name, type.slug, url.

  • :q (String) —

    Perform a generic substring search across all fields.

Returns:



1412
1413
1414
1415
 
# File 'lib/crimson-falcon/api/intel.rb', line 1412

def query_intel_report_ids(opts = {})
  data, _status_code, _headers = query_intel_report_ids_with_http_info(opts)
  data
end

#query_intel_report_ids_with_http_info(opts = {}) ⇒ Array<(MsaQueryResponse, Integer, Hash)>

Get report IDs that match provided FQL filters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Set the starting row number to return report IDs from. Defaults to 0.

  • :limit (Integer) —

    Set the number of report IDs to return. The value must be between 1 and 5000.

  • :sort (String) —

    Order fields in ascending or descending order. Ex: created_date|asc.

  • :filter (String) —

    Filter your query by specifying FQL filter parameters. Filter parameters include: actors, actors.animal_classifier, actors.id, actors.name, actors.slug, actors.url, created_date, description, id, last_modified_date, malware, malware.community_identifiers, malware.family_name, malware.slug, motivations, motivations.id, motivations.slug, motivations.value, name, name.raw, short_description, slug, sub_type, sub_type.id, sub_type.name, sub_type.slug, summary, tags, tags.id, tags.slug, tags.value, target_countries, target_countries.id, target_countries.slug, target_countries.value, target_industries, target_industries.id, target_industries.slug, target_industries.value, type, type.id, type.name, type.slug, url.

  • :q (String) —

    Perform a generic substring search across all fields.

Returns:

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

    MsaQueryResponse data, response status code and response headers



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

def query_intel_report_ids_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.query_intel_report_ids ...'
  end
  # resource path
  local_var_path = '/intel/queries/reports/v1'

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

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

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

#query_intel_rule_ids(type, opts = {}) ⇒ MsaQueryResponse

Search for rule IDs that match provided filter criteria.

Parameters:

  • type (String) —

    The rule news report type. Accepted values: snort-suricata-master snort-suricata-update snort-suricata-changelog yara-master yara-update yara-changelog common-event-format netwitness cql-master cql-update cql-changelog

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Set the starting row number to return reports from. Defaults to 0.

  • :limit (Integer) —

    The number of rule IDs to return. Defaults to 10.

  • :sort (String) —

    Order fields in ascending or descending order. Ex: created_date|asc.

  • :name (Array<String>) —

    Search by rule title.

  • :description (Array<String>) —

    Substring match on description field.

  • :tags (Array<String>) —

    Search for rule tags.

  • :min_created_date (Integer) —

    Filter results to those created on or after a certain date.

  • :max_created_date (String) —

    Filter results to those created on or before a certain date.

  • :q (String) —

    Perform a generic substring search across all fields.

Returns:



1487
1488
1489
1490
 
# File 'lib/crimson-falcon/api/intel.rb', line 1487

def query_intel_rule_ids(type, opts = {})
  data, _status_code, _headers = query_intel_rule_ids_with_http_info(type, opts)
  data
end

#query_intel_rule_ids_with_http_info(type, opts = {}) ⇒ Array<(MsaQueryResponse, Integer, Hash)>

Search for rule IDs that match provided filter criteria.

Parameters:

  • type (String) —

    The rule news report type. Accepted values: snort-suricata-master snort-suricata-update snort-suricata-changelog yara-master yara-update yara-changelog common-event-format netwitness cql-master cql-update cql-changelog

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Set the starting row number to return reports from. Defaults to 0.

  • :limit (Integer) —

    The number of rule IDs to return. Defaults to 10.

  • :sort (String) —

    Order fields in ascending or descending order. Ex: created_date|asc.

  • :name (Array<String>) —

    Search by rule title.

  • :description (Array<String>) —

    Substring match on description field.

  • :tags (Array<String>) —

    Search for rule tags.

  • :min_created_date (Integer) —

    Filter results to those created on or after a certain date.

  • :max_created_date (String) —

    Filter results to those created on or before a certain date.

  • :q (String) —

    Perform a generic substring search across all fields.

Returns:

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

    MsaQueryResponse data, response status code and response headers



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
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
 
# File 'lib/crimson-falcon/api/intel.rb', line 1505

def query_intel_rule_ids_with_http_info(type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.query_intel_rule_ids ...'
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling Intel.query_intel_rule_ids"
  end
  # resource path
  local_var_path = '/intel/queries/rules/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'type'] = type
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'name'] = @api_client.build_collection_param(opts[:'name'], :csv) if !opts[:'name'].nil?
  query_params[:'description'] = @api_client.build_collection_param(opts[:'description'], :csv) if !opts[:'description'].nil?
  query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
  query_params[:'min_created_date'] = opts[:'min_created_date'] if !opts[:'min_created_date'].nil?
  query_params[:'max_created_date'] = opts[:'max_created_date'] if !opts[:'max_created_date'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].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] || 'MsaQueryResponse'

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

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

#query_malware(opts = {}) ⇒ DomainQueryResponse

Get malware family names that match provided FQL filters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Set the starting row number to return malware IDs from. Defaults to 0.

  • :limit (Integer) —

    Set the number of malware IDs to return. The value must be between 1 and 5000.

  • :sort (String) —

    Order fields in ascending or descending order. Ex: created_date|asc.

  • :filter (String) —

    Filter your query by specifying FQL filter parameters.

  • :q (String) —

    Perform a generic substring search across all fields.

Returns:



1571
1572
1573
1574
 
# File 'lib/crimson-falcon/api/intel.rb', line 1571

def query_malware(opts = {})
  data, _status_code, _headers = query_malware_with_http_info(opts)
  data
end

#query_malware_entities(opts = {}) ⇒ DomainMalwareResponse

Get malware entities that match provided FQL filters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Set the starting row number to return malware IDs from. Defaults to 0.

  • :limit (Integer) —

    Set the number of malware IDs to return. The value must be between 1 and 5000.

  • :sort (String) —

    Order fields in ascending or descending order. Ex: created_date|asc.

  • :filter (String) —

    Filter your query by specifying FQL filter parameters.

  • :q (String) —

    Perform a generic substring search across all fields.

  • :fields (Array<String>) —

    The fields to return

Returns:



1642
1643
1644
1645
 
# File 'lib/crimson-falcon/api/intel.rb', line 1642

def query_malware_entities(opts = {})
  data, _status_code, _headers = query_malware_entities_with_http_info(opts)
  data
end

#query_malware_entities_with_http_info(opts = {}) ⇒ Array<(DomainMalwareResponse, Integer, Hash)>

Get malware entities that match provided FQL filters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Set the starting row number to return malware IDs from. Defaults to 0.

  • :limit (Integer) —

    Set the number of malware IDs to return. The value must be between 1 and 5000.

  • :sort (String) —

    Order fields in ascending or descending order. Ex: created_date|asc.

  • :filter (String) —

    Filter your query by specifying FQL filter parameters.

  • :q (String) —

    Perform a generic substring search across all fields.

  • :fields (Array<String>) —

    The fields to return

Returns:

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

    DomainMalwareResponse data, response status code and response headers



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
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
 
# File 'lib/crimson-falcon/api/intel.rb', line 1656

def query_malware_entities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.query_malware_entities ...'
  end
  # resource path
  local_var_path = '/intel/combined/malware/v1'

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

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

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

#query_malware_with_http_info(opts = {}) ⇒ Array<(DomainQueryResponse, Integer, Hash)>

Get malware family names that match provided FQL filters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Set the starting row number to return malware IDs from. Defaults to 0.

  • :limit (Integer) —

    Set the number of malware IDs to return. The value must be between 1 and 5000.

  • :sort (String) —

    Order fields in ascending or descending order. Ex: created_date|asc.

  • :filter (String) —

    Filter your query by specifying FQL filter parameters.

  • :q (String) —

    Perform a generic substring search across all fields.

Returns:

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

    DomainQueryResponse data, response status code and response headers



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
1623
1624
1625
1626
1627
1628
1629
1630
1631
 
# File 'lib/crimson-falcon/api/intel.rb', line 1584

def query_malware_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.query_malware ...'
  end
  # resource path
  local_var_path = '/intel/queries/malware/v1'

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

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

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

#query_mitre_attacks(opts = {}) ⇒ DomainQueryMitreAttacksResponse

Gets MITRE tactics and techniques for the given actor, returning concatenation of id and tactic and technique ids, example: fancy-bear_TA0011_T1071

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    The actor ID(derived from the actor&#39;s name) for which to retrieve a list of attacks, for example: fancy-bear. Only one value is allowed

  • :ids (Array<String>) —

    The actor ID(derived from the actor&#39;s name) for which to retrieve a list of attacks, for example: fancy-bear. Multiple values are allowed

Returns:



1711
1712
1713
1714
 
# File 'lib/crimson-falcon/api/intel.rb', line 1711

def query_mitre_attacks(opts = {})
  data, _status_code, _headers = query_mitre_attacks_with_http_info(opts)
  data
end

#query_mitre_attacks_for_malware(ids, opts = {}) ⇒ DomainQueryResponse

Gets MITRE tactics and techniques for the given malware

Parameters:

  • ids (Array<String>) —

    Malware family name in lower case with spaces replaced with dashes

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

    the optional parameters

Returns:



1771
1772
1773
1774
 
# File 'lib/crimson-falcon/api/intel.rb', line 1771

def query_mitre_attacks_for_malware(ids, opts = {})
  data, _status_code, _headers = query_mitre_attacks_for_malware_with_http_info(ids, opts)
  data
end

#query_mitre_attacks_for_malware_with_http_info(ids, opts = {}) ⇒ Array<(DomainQueryResponse, Integer, Hash)>

Gets MITRE tactics and techniques for the given malware

Parameters:

  • ids (Array<String>) —

    Malware family name in lower case with spaces replaced with dashes

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

    the optional parameters

Returns:

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

    DomainQueryResponse data, response status code and response headers



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
1822
1823
1824
1825
1826
1827
 
# File 'lib/crimson-falcon/api/intel.rb', line 1780

def query_mitre_attacks_for_malware_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.query_mitre_attacks_for_malware ...'
  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 Intel.query_mitre_attacks_for_malware"
  end
  # resource path
  local_var_path = '/intel/queries/mitre-malware/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] || 'DomainQueryResponse'

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

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

#query_mitre_attacks_with_http_info(opts = {}) ⇒ Array<(DomainQueryMitreAttacksResponse, Integer, Hash)>

Gets MITRE tactics and techniques for the given actor, returning concatenation of id and tactic and technique ids, example: fancy-bear_TA0011_T1071

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    The actor ID(derived from the actor&#39;s name) for which to retrieve a list of attacks, for example: fancy-bear. Only one value is allowed

  • :ids (Array<String>) —

    The actor ID(derived from the actor&#39;s name) for which to retrieve a list of attacks, for example: fancy-bear. Multiple values are allowed

Returns:



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
1760
1761
1762
1763
1764
1765
 
# File 'lib/crimson-falcon/api/intel.rb', line 1721

def query_mitre_attacks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.query_mitre_attacks ...'
  end
  # resource path
  local_var_path = '/intel/queries/mitre/v1'

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

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

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

#query_vulnerabilities(opts = {}) ⇒ MsaQueryResponse

Get vulnerabilities IDs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

    Starting index of result set from which to return IDs.

  • :limit (Integer) —

    Number of IDs to return.

  • :sort (String) —

    Order by fields.

  • :filter (String) —

    FQL query specifying the filter parameters. Filter parameters include: _all, affected_products.product, affected_products.vendor, community_identifiers, cve, cvss_v3_base, cvss_v3_base.score, cvss_v3_base.severity, exploit_status, publish_date, related_actors, related_actors.animal_classifier, related_actors.name, related_reports.serial_id, related_reports.title, related_threats, related_threats.name, severity, updated_timestamp.

  • :q (String) —

    Match phrase_prefix query criteria; included fields: _all (all filter string fields indexed).

Returns:



1837
1838
1839
1840
 
# File 'lib/crimson-falcon/api/intel.rb', line 1837

def query_vulnerabilities(opts = {})
  data, _status_code, _headers = query_vulnerabilities_with_http_info(opts)
  data
end

#query_vulnerabilities_with_http_info(opts = {}) ⇒ Array<(MsaQueryResponse, Integer, Hash)>

Get vulnerabilities IDs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

    Starting index of result set from which to return IDs.

  • :limit (Integer) —

    Number of IDs to return.

  • :sort (String) —

    Order by fields.

  • :filter (String) —

    FQL query specifying the filter parameters. Filter parameters include: _all, affected_products.product, affected_products.vendor, community_identifiers, cve, cvss_v3_base, cvss_v3_base.score, cvss_v3_base.severity, exploit_status, publish_date, related_actors, related_actors.animal_classifier, related_actors.name, related_reports.serial_id, related_reports.title, related_threats, related_threats.name, severity, updated_timestamp.

  • :q (String) —

    Match phrase_prefix query criteria; included fields: _all (all filter string fields indexed).

Returns:

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

    MsaQueryResponse data, response status code and response headers



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
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
 
# File 'lib/crimson-falcon/api/intel.rb', line 1850

def query_vulnerabilities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Intel.query_vulnerabilities ...'
  end
  # resource path
  local_var_path = '/intel/queries/vulnerabilities/v1'

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

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

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