Class: Falcon::IocApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IocApi

Returns a new instance of IocApi.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#action_get_v1(opts = {}) ⇒ ApiActionRespV1

Get Actions by ids.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    The ids of the Actions to retrieve

Returns:



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

def action_get_v1(opts = {})
  data, _status_code, _headers = action_get_v1_with_http_info(opts)
  data
end

#action_get_v1_with_http_info(opts = {}) ⇒ Array<(ApiActionRespV1, Integer, Hash)>

Get Actions by ids.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    The ids of the Actions to retrieve

Returns:

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

    ApiActionRespV1 data, response status code and response headers



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

def action_get_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IocApi.action_get_v1 ...'
  end
  # resource path
  local_var_path = '/iocs/entities/actions/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  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] || 'ApiActionRespV1'

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

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

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

#action_query_v1(opts = {}) ⇒ ApiIndicatorQueryRespV1

Query Actions.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

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

  • :limit (Integer) —

    Number of ids to return.

Returns:



102
103
104
105
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 102

def action_query_v1(opts = {})
  data, _status_code, _headers = action_query_v1_with_http_info(opts)
  data
end

#action_query_v1_with_http_info(opts = {}) ⇒ Array<(ApiIndicatorQueryRespV1, Integer, Hash)>

Query Actions.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

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

  • :limit (Integer) —

    Number of ids to return.

Returns:

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

    ApiIndicatorQueryRespV1 data, response status code and response headers



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 112

def action_query_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IocApi.action_query_v1 ...'
  end
  # resource path
  local_var_path = '/iocs/queries/actions/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?

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

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

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

#get_indicators_report(body, opts = {}) ⇒ MsaEntitiesResponse

Launch an indicators report creation job

Parameters:

Returns:



162
163
164
165
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 162

def get_indicators_report(body, opts = {})
  data, _status_code, _headers = get_indicators_report_with_http_info(body, opts)
  data
end

#get_indicators_report_with_http_info(body, opts = {}) ⇒ Array<(MsaEntitiesResponse, Integer, Hash)>

Launch an indicators report creation job

Parameters:

Returns:

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

    MsaEntitiesResponse data, response status code and response headers



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
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
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 171

def get_indicators_report_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IocApi.get_indicators_report ...'
  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 IocApi.get_indicators_report"
  end
  # resource path
  local_var_path = '/iocs/entities/indicators-reports/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] || 'MsaEntitiesResponse'

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

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

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

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

Parameters:

Options Hash (opts):

  • :filter (String) —

    The filter to narrow down the aggregation data

  • :from_parent (Boolean) —

    The filter for returning either only indicators for the request customer or its MSSP parents

Returns:



230
231
232
233
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 230

def indicator_aggregate_v1(body, opts = {})
  data, _status_code, _headers = indicator_aggregate_v1_with_http_info(body, opts)
  data
end

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

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

Parameters:

Options Hash (opts):

  • :filter (String) —

    The filter to narrow down the aggregation data

  • :from_parent (Boolean) —

    The filter for returning either only indicators for the request customer or its MSSP parents

Returns:

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

    MsaAggregatesResponse data, response status code and response headers



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 241

def indicator_aggregate_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IocApi.indicator_aggregate_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 IocApi.indicator_aggregate_v1"
  end
  # resource path
  local_var_path = '/iocs/aggregates/indicators/v1'

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

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

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

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

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

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

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

#indicator_combined_v1(opts = {}) ⇒ ApiIndicatorRespV1

Get Combined for Indicators.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results.

  • :offset (Integer) —

    The offset to start retrieving records from. Offset and After params are mutually exclusive. If none provided then scrolling will be used by default. To access more than 10k iocs, use the &#39;after&#39; parameter instead of &#39;offset&#39;.

  • :limit (Integer) —

    The maximum records to return.

  • :sort (String) —

    The sort expression that should be used to sort the results.

  • :after (String) —

    A pagination token used with the &#x60;limit&#x60; parameter to manage pagination of results. On your first request, don&#39;t provide an &#39;after&#39; token. On subsequent requests, provide the &#39;after&#39; token from the previous response to continue from that place in the results. To access more than 10k indicators, use the &#39;after&#39; parameter instead of &#39;offset&#39;.

  • :from_parent (Boolean) —

    The filter for returning either only indicators for the request customer or its MSSP parents

Returns:



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

def indicator_combined_v1(opts = {})
  data, _status_code, _headers = indicator_combined_v1_with_http_info(opts)
  data
end

#indicator_combined_v1_with_http_info(opts = {}) ⇒ Array<(ApiIndicatorRespV1, Integer, Hash)>

Get Combined for Indicators.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results.

  • :offset (Integer) —

    The offset to start retrieving records from. Offset and After params are mutually exclusive. If none provided then scrolling will be used by default. To access more than 10k iocs, use the &#39;after&#39; parameter instead of &#39;offset&#39;.

  • :limit (Integer) —

    The maximum records to return.

  • :sort (String) —

    The sort expression that should be used to sort the results.

  • :after (String) —

    A pagination token used with the &#x60;limit&#x60; parameter to manage pagination of results. On your first request, don&#39;t provide an &#39;after&#39; token. On subsequent requests, provide the &#39;after&#39; token from the previous response to continue from that place in the results. To access more than 10k indicators, use the &#39;after&#39; parameter instead of &#39;offset&#39;.

  • :from_parent (Boolean) —

    The filter for returning either only indicators for the request customer or its MSSP parents

Returns:

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

    ApiIndicatorRespV1 data, response status code and response headers



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

def indicator_combined_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IocApi.indicator_combined_v1 ...'
  end
  allowable_values = ["action", "applied_globally", "metadata.av_hits", "metadata.company_name.raw", "created_by", "created_on", "expiration", "expired", "metadata.filename.raw", "modified_by", "modified_on", "metadata.original_filename.raw", "metadata.product_name.raw", "metadata.product_version", "severity_number", "source", "type", "value"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/iocs/combined/indicator/v1'

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

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

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

#indicator_create_v1(body, opts = {}) ⇒ ApiIndicatorRespV1

Create Indicators.

Parameters:

Options Hash (opts):

  • :retrodetects (Boolean) —

    Whether to submit to retrodetects

  • :ignore_warnings (Boolean) —

    Set to true to ignore warnings and add all IOCs (default to false)

Returns:



379
380
381
382
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 379

def indicator_create_v1(body, opts = {})
  data, _status_code, _headers = indicator_create_v1_with_http_info(body, opts)
  data
end

#indicator_create_v1_with_http_info(body, opts = {}) ⇒ Array<(ApiIndicatorRespV1, Integer, Hash)>

Create Indicators.

Parameters:

Options Hash (opts):

  • :retrodetects (Boolean) —

    Whether to submit to retrodetects

  • :ignore_warnings (Boolean) —

    Set to true to ignore warnings and add all IOCs (default to false)

Returns:

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

    ApiIndicatorRespV1 data, response status code and response headers



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
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 390

def indicator_create_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IocApi.indicator_create_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 IocApi.indicator_create_v1"
  end
  # resource path
  local_var_path = '/iocs/entities/indicators/v1'

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

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

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

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

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

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

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

#indicator_delete_v1(opts = {}) ⇒ ApiIndicatorQueryRespV1

Delete Indicators by ids.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The FQL expression to delete Indicators in bulk. If both &#39;filter&#39; and &#39;ids&#39; are provided, then filter takes precedence and ignores ids.

  • :ids (Array<String>) —

    The ids of the Indicators to delete. If both &#39;filter&#39; and &#39;ids&#39; are provided, then filter takes precedence and ignores ids

  • :comment (String) —

    The comment why these indicators were deleted

  • :from_parent (Boolean) —

    The filter for returning either only indicators for the request customer or its MSSP parents

Returns:



452
453
454
455
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 452

def indicator_delete_v1(opts = {})
  data, _status_code, _headers = indicator_delete_v1_with_http_info(opts)
  data
end

#indicator_delete_v1_with_http_info(opts = {}) ⇒ Array<(ApiIndicatorQueryRespV1, Integer, Hash)>

Delete Indicators by ids.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The FQL expression to delete Indicators in bulk. If both &#39;filter&#39; and &#39;ids&#39; are provided, then filter takes precedence and ignores ids.

  • :ids (Array<String>) —

    The ids of the Indicators to delete. If both &#39;filter&#39; and &#39;ids&#39; are provided, then filter takes precedence and ignores ids

  • :comment (String) —

    The comment why these indicators were deleted

  • :from_parent (Boolean) —

    The filter for returning either only indicators for the request customer or its MSSP parents

Returns:

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

    ApiIndicatorQueryRespV1 data, response status code and response headers



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

def indicator_delete_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IocApi.indicator_delete_v1 ...'
  end
  # resource path
  local_var_path = '/iocs/entities/indicators/v1'

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

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

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

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

#indicator_get_device_count_v1(type, value, opts = {}) ⇒ ApiDeviceCountRespV1

Get the number of devices the indicator has run on

Parameters:

  • type (String) —

    The type of the indicator. Valid types include: sha256: A hex-encoded sha256 hash string. Length - min: 64, max: 64. md5: A hex-encoded md5 hash string. Length - min 32, max: 32. domain: A domain name. Length - min: 1, max: 200. ipv4: An IPv4 address. Must be a valid IP address. ipv6: An IPv6 address. Must be a valid IP address.

  • value (String) —

    The string representation of the indicator

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

    the optional parameters

Returns:



517
518
519
520
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 517

def indicator_get_device_count_v1(type, value, opts = {})
  data, _status_code, _headers = indicator_get_device_count_v1_with_http_info(type, value, opts)
  data
end

#indicator_get_device_count_v1_with_http_info(type, value, opts = {}) ⇒ Array<(ApiDeviceCountRespV1, Integer, Hash)>

Get the number of devices the indicator has run on

Parameters:

  • type (String) —

    The type of the indicator. Valid types include: sha256: A hex-encoded sha256 hash string. Length - min: 64, max: 64. md5: A hex-encoded md5 hash string. Length - min 32, max: 32. domain: A domain name. Length - min: 1, max: 200. ipv4: An IPv4 address. Must be a valid IP address. ipv6: An IPv6 address. Must be a valid IP address.

  • value (String) —

    The string representation of the indicator

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

    the optional parameters

Returns:

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

    ApiDeviceCountRespV1 data, response status code and response headers



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 527

def indicator_get_device_count_v1_with_http_info(type, value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IocApi.indicator_get_device_count_v1 ...'
  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 IocApi.indicator_get_device_count_v1"
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling IocApi.indicator_get_device_count_v1"
  end
  # resource path
  local_var_path = '/iocs/aggregates/indicators/device-count/v1'

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

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

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

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

#indicator_get_devices_ran_on_v1(type, value, opts = {}) ⇒ ApiDevicesRanOnRespV1

Get the IDs of devices the indicator has run on

Parameters:

  • type (String) —

    The type of the indicator. Valid types include: sha256: A hex-encoded sha256 hash string. Length - min: 64, max: 64. md5: A hex-encoded md5 hash string. Length - min 32, max: 32. domain: A domain name. Length - min: 1, max: 200. ipv4: An IPv4 address. Must be a valid IP address. ipv6: An IPv6 address. Must be a valid IP address.

  • value (String) —

    The string representation of the indicator

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

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    The maximum number of results to return. Use with the offset parameter to manage pagination of results.

  • :offset (String) —

    The first process to return, where 0 is the latest offset. Use with the limit parameter to manage pagination of results.

Returns:



588
589
590
591
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 588

def indicator_get_devices_ran_on_v1(type, value, opts = {})
  data, _status_code, _headers = indicator_get_devices_ran_on_v1_with_http_info(type, value, opts)
  data
end

#indicator_get_devices_ran_on_v1_with_http_info(type, value, opts = {}) ⇒ Array<(ApiDevicesRanOnRespV1, Integer, Hash)>

Get the IDs of devices the indicator has run on

Parameters:

  • type (String) —

    The type of the indicator. Valid types include: sha256: A hex-encoded sha256 hash string. Length - min: 64, max: 64. md5: A hex-encoded md5 hash string. Length - min 32, max: 32. domain: A domain name. Length - min: 1, max: 200. ipv4: An IPv4 address. Must be a valid IP address. ipv6: An IPv6 address. Must be a valid IP address.

  • value (String) —

    The string representation of the indicator

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

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    The maximum number of results to return. Use with the offset parameter to manage pagination of results.

  • :offset (String) —

    The first process to return, where 0 is the latest offset. Use with the limit parameter to manage pagination of results.

Returns:

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

    ApiDevicesRanOnRespV1 data, response status code and response headers



600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 600

def indicator_get_devices_ran_on_v1_with_http_info(type, value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IocApi.indicator_get_devices_ran_on_v1 ...'
  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 IocApi.indicator_get_devices_ran_on_v1"
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling IocApi.indicator_get_devices_ran_on_v1"
  end
  # resource path
  local_var_path = '/iocs/queries/indicators/devices/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'type'] = type
  query_params[:'value'] = value
  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] || 'ApiDevicesRanOnRespV1'

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

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

#indicator_get_processes_ran_on_v1(type, value, device_id, opts = {}) ⇒ ApiProcessesRanOnRespV1

Get the number of processes the indicator has run on

Parameters:

  • type (String) —

    The type of the indicator. Valid types include: sha256: A hex-encoded sha256 hash string. Length - min: 64, max: 64. md5: A hex-encoded md5 hash string. Length - min 32, max: 32. domain: A domain name. Length - min: 1, max: 200. ipv4: An IPv4 address. Must be a valid IP address. ipv6: An IPv6 address. Must be a valid IP address.

  • value (String) —

    The string representation of the indicator

  • device_id (String) —

    Specify a host&#39;s ID to return only processes from that host. Get a host&#39;s ID from GET /devices/queries/devices/v1, the Falcon console, or the Streaming API.

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

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    The maximum number of results to return. Use with the offset parameter to manage pagination of results.

  • :offset (String) —

    The first process to return, where 0 is the latest offset. Use with the limit parameter to manage pagination of results.

Returns:



664
665
666
667
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 664

def indicator_get_processes_ran_on_v1(type, value, device_id, opts = {})
  data, _status_code, _headers = indicator_get_processes_ran_on_v1_with_http_info(type, value, device_id, opts)
  data
end

#indicator_get_processes_ran_on_v1_with_http_info(type, value, device_id, opts = {}) ⇒ Array<(ApiProcessesRanOnRespV1, Integer, Hash)>

Get the number of processes the indicator has run on

Parameters:

  • type (String) —

    The type of the indicator. Valid types include: sha256: A hex-encoded sha256 hash string. Length - min: 64, max: 64. md5: A hex-encoded md5 hash string. Length - min 32, max: 32. domain: A domain name. Length - min: 1, max: 200. ipv4: An IPv4 address. Must be a valid IP address. ipv6: An IPv6 address. Must be a valid IP address.

  • value (String) —

    The string representation of the indicator

  • device_id (String) —

    Specify a host&#39;s ID to return only processes from that host. Get a host&#39;s ID from GET /devices/queries/devices/v1, the Falcon console, or the Streaming API.

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

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    The maximum number of results to return. Use with the offset parameter to manage pagination of results.

  • :offset (String) —

    The first process to return, where 0 is the latest offset. Use with the limit parameter to manage pagination of results.

Returns:

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

    ApiProcessesRanOnRespV1 data, response status code and response headers



677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 677

def indicator_get_processes_ran_on_v1_with_http_info(type, value, device_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IocApi.indicator_get_processes_ran_on_v1 ...'
  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 IocApi.indicator_get_processes_ran_on_v1"
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling IocApi.indicator_get_processes_ran_on_v1"
  end
  # verify the required parameter 'device_id' is set
  if @api_client.config.client_side_validation && device_id.nil?
    fail ArgumentError, "Missing the required parameter 'device_id' when calling IocApi.indicator_get_processes_ran_on_v1"
  end
  # resource path
  local_var_path = '/iocs/queries/indicators/processes/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'type'] = type
  query_params[:'value'] = value
  query_params[:'device_id'] = device_id
  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] || 'ApiProcessesRanOnRespV1'

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

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

#indicator_get_v1(ids, opts = {}) ⇒ ApiIndicatorRespV1

Get Indicators by ids.

Parameters:

  • ids (Array<String>) —

    The ids of the Indicators to retrieve

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

    the optional parameters

Returns:



742
743
744
745
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 742

def indicator_get_v1(ids, opts = {})
  data, _status_code, _headers = indicator_get_v1_with_http_info(ids, opts)
  data
end

#indicator_get_v1_with_http_info(ids, opts = {}) ⇒ Array<(ApiIndicatorRespV1, Integer, Hash)>

Get Indicators by ids.

Parameters:

  • ids (Array<String>) —

    The ids of the Indicators to retrieve

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

    the optional parameters

Returns:

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

    ApiIndicatorRespV1 data, response status code and response headers



751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 751

def indicator_get_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IocApi.indicator_get_v1 ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling IocApi.indicator_get_v1"
  end
  # resource path
  local_var_path = '/iocs/entities/indicators/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] || 'ApiIndicatorRespV1'

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

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

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

#indicator_search_v1(opts = {}) ⇒ ApiIndicatorQueryRespV1

Search for Indicators.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results.

  • :offset (Integer) —

    The offset to start retrieving records from. Offset and After params are mutually exclusive. If none provided then scrolling will be used by default. To access more than 10k iocs, use the &#39;after&#39; parameter instead of &#39;offset&#39;.

  • :limit (Integer) —

    The maximum records to return.

  • :sort (String) —

    The sort expression that should be used to sort the results.

  • :after (String) —

    A pagination token used with the &#x60;limit&#x60; parameter to manage pagination of results. On your first request, don&#39;t provide an &#39;after&#39; token. On subsequent requests, provide the &#39;after&#39; token from the previous response to continue from that place in the results. To access more than 10k indicators, use the &#39;after&#39; parameter instead of &#39;offset&#39;.

  • :from_parent (Boolean) —

    The filter for returning either only indicators for the request customer or its MSSP parents

Returns:



809
810
811
812
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 809

def indicator_search_v1(opts = {})
  data, _status_code, _headers = indicator_search_v1_with_http_info(opts)
  data
end

#indicator_search_v1_with_http_info(opts = {}) ⇒ Array<(ApiIndicatorQueryRespV1, Integer, Hash)>

Search for Indicators.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    The filter expression that should be used to limit the results.

  • :offset (Integer) —

    The offset to start retrieving records from. Offset and After params are mutually exclusive. If none provided then scrolling will be used by default. To access more than 10k iocs, use the &#39;after&#39; parameter instead of &#39;offset&#39;.

  • :limit (Integer) —

    The maximum records to return.

  • :sort (String) —

    The sort expression that should be used to sort the results.

  • :after (String) —

    A pagination token used with the &#x60;limit&#x60; parameter to manage pagination of results. On your first request, don&#39;t provide an &#39;after&#39; token. On subsequent requests, provide the &#39;after&#39; token from the previous response to continue from that place in the results. To access more than 10k indicators, use the &#39;after&#39; parameter instead of &#39;offset&#39;.

  • :from_parent (Boolean) —

    The filter for returning either only indicators for the request customer or its MSSP parents

Returns:

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

    ApiIndicatorQueryRespV1 data, response status code and response headers



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 823

def indicator_search_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IocApi.indicator_search_v1 ...'
  end
  allowable_values = ["action", "applied_globally", "metadata.av_hits", "metadata.company_name.raw", "created_by", "created_on", "expiration", "expired", "metadata.filename.raw", "modified_by", "modified_on", "metadata.original_filename.raw", "metadata.product_name.raw", "metadata.product_version", "severity_number", "source", "type", "value"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/iocs/queries/indicators/v1'

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

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

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

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

#indicator_update_v1(body, opts = {}) ⇒ ApiIndicatorRespV1

Update Indicators.

Parameters:

Options Hash (opts):

  • :retrodetects (Boolean) —

    Whether to submit to retrodetects

  • :ignore_warnings (Boolean) —

    Set to true to ignore warnings and add all IOCs (default to false)

Returns:



883
884
885
886
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 883

def indicator_update_v1(body, opts = {})
  data, _status_code, _headers = indicator_update_v1_with_http_info(body, opts)
  data
end

#indicator_update_v1_with_http_info(body, opts = {}) ⇒ Array<(ApiIndicatorRespV1, Integer, Hash)>

Update Indicators.

Parameters:

Options Hash (opts):

  • :retrodetects (Boolean) —

    Whether to submit to retrodetects

  • :ignore_warnings (Boolean) —

    Set to true to ignore warnings and add all IOCs (default to false)

Returns:

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

    ApiIndicatorRespV1 data, response status code and response headers



894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 894

def indicator_update_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IocApi.indicator_update_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 IocApi.indicator_update_v1"
  end
  # resource path
  local_var_path = '/iocs/entities/indicators/v1'

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

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

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

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

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

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

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

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

#ioc_type_query_v1(opts = {}) ⇒ ApiIndicatorQueryRespV1

Query IOC Types.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

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

  • :limit (Integer) —

    Number of ids to return.

Returns:



954
955
956
957
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 954

def ioc_type_query_v1(opts = {})
  data, _status_code, _headers = ioc_type_query_v1_with_http_info(opts)
  data
end

#ioc_type_query_v1_with_http_info(opts = {}) ⇒ Array<(ApiIndicatorQueryRespV1, Integer, Hash)>

Query IOC Types.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

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

  • :limit (Integer) —

    Number of ids to return.

Returns:

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

    ApiIndicatorQueryRespV1 data, response status code and response headers



964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 964

def ioc_type_query_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IocApi.ioc_type_query_v1 ...'
  end
  # resource path
  local_var_path = '/iocs/queries/ioc-types/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?

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

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

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

#platform_query_v1(opts = {}) ⇒ ApiIndicatorQueryRespV1

Query Platforms.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

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

  • :limit (Integer) —

    Number of ids to return.

Returns:



1015
1016
1017
1018
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 1015

def platform_query_v1(opts = {})
  data, _status_code, _headers = platform_query_v1_with_http_info(opts)
  data
end

#platform_query_v1_with_http_info(opts = {}) ⇒ Array<(ApiIndicatorQueryRespV1, Integer, Hash)>

Query Platforms.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

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

  • :limit (Integer) —

    Number of ids to return.

Returns:

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

    ApiIndicatorQueryRespV1 data, response status code and response headers



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

def platform_query_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IocApi.platform_query_v1 ...'
  end
  # resource path
  local_var_path = '/iocs/queries/platforms/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?

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

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

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

#severity_query_v1(opts = {}) ⇒ ApiIndicatorQueryRespV1

Query Severities.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

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

  • :limit (Integer) —

    Number of ids to return.

Returns:



1076
1077
1078
1079
 
# File 'lib/crimson-falcon/api/ioc_api.rb', line 1076

def severity_query_v1(opts = {})
  data, _status_code, _headers = severity_query_v1_with_http_info(opts)
  data
end

#severity_query_v1_with_http_info(opts = {}) ⇒ Array<(ApiIndicatorQueryRespV1, Integer, Hash)>

Query Severities.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

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

  • :limit (Integer) —

    Number of ids to return.

Returns:

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

    ApiIndicatorQueryRespV1 data, response status code and response headers



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

def severity_query_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IocApi.severity_query_v1 ...'
  end
  # resource path
  local_var_path = '/iocs/queries/severities/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?

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

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

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