Class: Falcon::Recon

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Recon

Returns a new instance of Recon.



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

def api_client
  @api_client
end

Instance Method Details

#aggregate_notifications_exposed_data_records_v1(body, opts = {}) ⇒ DomainAggregatesResponse

Get notification exposed data record aggregates as specified via JSON in request body. The valid aggregation fields are: [cid notification_id notification_group_id created_date rule.id rule.name rule.topic source_category site author file.name credential_status bot.operating_system.hardware_id bot.bot_id]

Parameters:

Returns:



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

def aggregate_notifications_exposed_data_records_v1(body, opts = {})
  data, _status_code, _headers = aggregate_notifications_exposed_data_records_v1_with_http_info(body, opts)
  data
end

#aggregate_notifications_exposed_data_records_v1_with_http_info(body, opts = {}) ⇒ Array<(DomainAggregatesResponse, Integer, Hash)>

Get notification exposed data record aggregates as specified via JSON in request body. The valid aggregation fields are: [cid notification_id notification_group_id created_date rule.id rule.name rule.topic source_category site author file.name credential_status bot.operating_system.hardware_id bot.bot_id]

Parameters:

Returns:

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

    DomainAggregatesResponse 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/recon.rb', line 51

def aggregate_notifications_exposed_data_records_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.aggregate_notifications_exposed_data_records_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 Recon.aggregate_notifications_exposed_data_records_v1"
  end
  # resource path
  local_var_path = '/recon/aggregates/notifications-exposed-data-records/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] || 'DomainAggregatesResponse'

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

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

#aggregate_notifications_v1(body, opts = {}) ⇒ DomainAggregatesResponse

Get notification aggregates as specified via JSON in request body.

Parameters:

Returns:



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

def aggregate_notifications_v1(body, opts = {})
  data, _status_code, _headers = aggregate_notifications_v1_with_http_info(body, opts)
  data
end

#aggregate_notifications_v1_with_http_info(body, opts = {}) ⇒ Array<(DomainAggregatesResponse, Integer, Hash)>

Get notification aggregates as specified via JSON in request body.

Parameters:

Returns:

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

    DomainAggregatesResponse 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/recon.rb', line 117

def aggregate_notifications_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.aggregate_notifications_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 Recon.aggregate_notifications_v1"
  end
  # resource path
  local_var_path = '/recon/aggregates/notifications/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] || 'DomainAggregatesResponse'

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

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

#create_actions_v1(body, opts = {}) ⇒ DomainActionEntitiesResponseV1

Create actions for a monitoring rule. Accepts a list of actions that will be attached to the monitoring rule.

Parameters:

Returns:



174
175
176
177
 
# File 'lib/crimson-falcon/api/recon.rb', line 174

def create_actions_v1(body, opts = {})
  data, _status_code, _headers = create_actions_v1_with_http_info(body, opts)
  data
end

#create_actions_v1_with_http_info(body, opts = {}) ⇒ Array<(DomainActionEntitiesResponseV1, Integer, Hash)>

Create actions for a monitoring rule. Accepts a list of actions that will be attached to the monitoring rule.

Parameters:

Returns:



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/crimson-falcon/api/recon.rb', line 183

def create_actions_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.create_actions_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 Recon.create_actions_v1"
  end
  # resource path
  local_var_path = '/recon/entities/actions/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] || 'DomainActionEntitiesResponseV1'

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

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

#create_export_jobs_v1(body, opts = {}) ⇒ DomainLaunchExportJobResponseV1

Launch asynchronous export job. Use the job ID to poll the status of the job using GET /entities/exports/v1.

Parameters:

Returns:



240
241
242
243
 
# File 'lib/crimson-falcon/api/recon.rb', line 240

def create_export_jobs_v1(body, opts = {})
  data, _status_code, _headers = create_export_jobs_v1_with_http_info(body, opts)
  data
end

#create_export_jobs_v1_with_http_info(body, opts = {}) ⇒ Array<(DomainLaunchExportJobResponseV1, Integer, Hash)>

Launch asynchronous export job. Use the job ID to poll the status of the job using GET /entities/exports/v1.

Parameters:

Returns:



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

def create_export_jobs_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.create_export_jobs_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 Recon.create_export_jobs_v1"
  end
  # resource path
  local_var_path = '/recon/entities/exports/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] || 'DomainLaunchExportJobResponseV1'

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

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

#create_rules_v1(body, opts = {}) ⇒ DomainRulesEntitiesResponseV1

Create monitoring rules.

Parameters:

Returns:



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

def create_rules_v1(body, opts = {})
  data, _status_code, _headers = create_rules_v1_with_http_info(body, opts)
  data
end

#create_rules_v1_with_http_info(body, opts = {}) ⇒ Array<(DomainRulesEntitiesResponseV1, Integer, Hash)>

Create monitoring rules.

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/recon.rb', line 315

def create_rules_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.create_rules_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 Recon.create_rules_v1"
  end
  # resource path
  local_var_path = '/recon/entities/rules/v1'

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

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

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

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

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

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

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

#delete_action_v1(id, opts = {}) ⇒ DomainQueryResponse

Delete an action from a monitoring rule based on the action ID.

Parameters:

  • id (String) —

    ID of the action.

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

    the optional parameters

Returns:



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

def delete_action_v1(id, opts = {})
  data, _status_code, _headers = delete_action_v1_with_http_info(id, opts)
  data
end

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

Delete an action from a monitoring rule based on the action ID.

Parameters:

  • id (String) —

    ID of the action.

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

    the optional parameters

Returns:

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

    DomainQueryResponse data, response status code and response headers



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/crimson-falcon/api/recon.rb', line 381

def delete_action_v1_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.delete_action_v1 ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling Recon.delete_action_v1"
  end
  # resource path
  local_var_path = '/recon/entities/actions/v1'

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

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

#delete_export_jobs_v1(ids, opts = {}) ⇒ DomainExportJobIDResponseV1

Delete export jobs (and their associated file(s)) based on their IDs.

Parameters:

  • ids (Array<String>) —

    Export Job IDs.

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

    the optional parameters

Returns:



434
435
436
437
 
# File 'lib/crimson-falcon/api/recon.rb', line 434

def delete_export_jobs_v1(ids, opts = {})
  data, _status_code, _headers = delete_export_jobs_v1_with_http_info(ids, opts)
  data
end

#delete_export_jobs_v1_with_http_info(ids, opts = {}) ⇒ Array<(DomainExportJobIDResponseV1, Integer, Hash)>

Delete export jobs (and their associated file(s)) based on their IDs.

Parameters:

  • ids (Array<String>) —

    Export Job IDs.

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

    the optional parameters

Returns:

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

    DomainExportJobIDResponseV1 data, response status code and response headers



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/crimson-falcon/api/recon.rb', line 443

def delete_export_jobs_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.delete_export_jobs_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 Recon.delete_export_jobs_v1"
  end
  # resource path
  local_var_path = '/recon/entities/exports/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] || 'DomainExportJobIDResponseV1'

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

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

#delete_notifications_v1(ids, opts = {}) ⇒ DomainNotificationIDResponse

Delete notifications based on IDs. Notifications cannot be recovered after they are deleted.

Parameters:

  • ids (Array<String>) —

    Notifications IDs.

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

    the optional parameters

Returns:



496
497
498
499
 
# File 'lib/crimson-falcon/api/recon.rb', line 496

def delete_notifications_v1(ids, opts = {})
  data, _status_code, _headers = delete_notifications_v1_with_http_info(ids, opts)
  data
end

#delete_notifications_v1_with_http_info(ids, opts = {}) ⇒ Array<(DomainNotificationIDResponse, Integer, Hash)>

Delete notifications based on IDs. Notifications cannot be recovered after they are deleted.

Parameters:

  • ids (Array<String>) —

    Notifications IDs.

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

    the optional parameters

Returns:



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/crimson-falcon/api/recon.rb', line 505

def delete_notifications_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.delete_notifications_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 Recon.delete_notifications_v1"
  end
  # resource path
  local_var_path = '/recon/entities/notifications/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] || 'DomainNotificationIDResponse'

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

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

#delete_rules_v1(ids, opts = {}) ⇒ DomainRuleQueryResponseV1

Delete monitoring rules.

Parameters:

  • ids (Array<String>) —

    IDs of rules.

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

    the optional parameters

Options Hash (opts):

  • :notifications_deletion_requested (Boolean) —

    Whether we should delete the notifications generated by this rule or not

Returns:



559
560
561
562
 
# File 'lib/crimson-falcon/api/recon.rb', line 559

def delete_rules_v1(ids, opts = {})
  data, _status_code, _headers = delete_rules_v1_with_http_info(ids, opts)
  data
end

#delete_rules_v1_with_http_info(ids, opts = {}) ⇒ Array<(DomainRuleQueryResponseV1, Integer, Hash)>

Delete monitoring rules.

Parameters:

  • ids (Array<String>) —

    IDs of rules.

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

    the optional parameters

Options Hash (opts):

  • :notifications_deletion_requested (Boolean) —

    Whether we should delete the notifications generated by this rule or not

Returns:

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

    DomainRuleQueryResponseV1 data, response status code and response headers



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
 
# File 'lib/crimson-falcon/api/recon.rb', line 569

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

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

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

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

#get_actions_v1(ids, opts = {}) ⇒ DomainActionEntitiesResponseV1

Get actions based on their IDs. IDs can be retrieved using the GET /queries/actions/v1 endpoint.

Parameters:

  • ids (Array<String>) —

    Action IDs.

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

    the optional parameters

Returns:



623
624
625
626
 
# File 'lib/crimson-falcon/api/recon.rb', line 623

def get_actions_v1(ids, opts = {})
  data, _status_code, _headers = get_actions_v1_with_http_info(ids, opts)
  data
end

#get_actions_v1_with_http_info(ids, opts = {}) ⇒ Array<(DomainActionEntitiesResponseV1, Integer, Hash)>

Get actions based on their IDs. IDs can be retrieved using the GET /queries/actions/v1 endpoint.

Parameters:

  • ids (Array<String>) —

    Action IDs.

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

    the optional parameters

Returns:



632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/crimson-falcon/api/recon.rb', line 632

def get_actions_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.get_actions_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 Recon.get_actions_v1"
  end
  # resource path
  local_var_path = '/recon/entities/actions/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] || 'DomainActionEntitiesResponseV1'

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

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

#get_export_jobs_v1(ids, opts = {}) ⇒ DomainExportJobEntitiesResponseV1

Get the status of export jobs based on their IDs. Export jobs can be launched by calling POST /entities/exports/v1. When a job is complete, use the job ID to download the file(s) associated with it using GET entities/export-files/v1.

Parameters:

  • ids (Array<String>) —

    Export Job IDs.

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

    the optional parameters

Returns:



685
686
687
688
 
# File 'lib/crimson-falcon/api/recon.rb', line 685

def get_export_jobs_v1(ids, opts = {})
  data, _status_code, _headers = get_export_jobs_v1_with_http_info(ids, opts)
  data
end

#get_export_jobs_v1_with_http_info(ids, opts = {}) ⇒ Array<(DomainExportJobEntitiesResponseV1, Integer, Hash)>

Get the status of export jobs based on their IDs. Export jobs can be launched by calling POST /entities/exports/v1. When a job is complete, use the job ID to download the file(s) associated with it using GET entities/export-files/v1.

Parameters:

  • ids (Array<String>) —

    Export Job IDs.

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

    the optional parameters

Returns:



694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/crimson-falcon/api/recon.rb', line 694

def get_export_jobs_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.get_export_jobs_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 Recon.get_export_jobs_v1"
  end
  # resource path
  local_var_path = '/recon/entities/exports/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] || 'DomainExportJobEntitiesResponseV1'

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

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

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

Download the file associated with a job ID.

Parameters:

  • id (String) —

    Export Job ID.

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

    the optional parameters

Returns:

  • (Array<Integer>) 


747
748
749
750
 
# File 'lib/crimson-falcon/api/recon.rb', line 747

def get_file_content_for_export_jobs_v1(id, opts = {})
  data, _status_code, _headers = get_file_content_for_export_jobs_v1_with_http_info(id, opts)
  data
end

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

Download the file associated with a job ID.

Parameters:

  • id (String) —

    Export Job ID.

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

    the optional parameters

Returns:

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

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



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
799
800
801
802
803
 
# File 'lib/crimson-falcon/api/recon.rb', line 756

def get_file_content_for_export_jobs_v1_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.get_file_content_for_export_jobs_v1 ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling Recon.get_file_content_for_export_jobs_v1"
  end
  # resource path
  local_var_path = '/recon/entities/export-files/v1'

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

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

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

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

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

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

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

#get_notifications_detailed_translated_v1(ids, opts = {}) ⇒ DomainNotificationDetailsResponseV1

Get detailed notifications based on their IDs. These include the translated raw intelligence content that generated the match or part of it. Get detailed notifications based on their IDs. These include the translated raw intelligence content that generated the match or part of it. This API endpoint will return translated notification content. The only target language available is English. A single notification can be translated per request. In case the item’s content is only partial, a URL is provided under the resource’s ‘details.full_content_url’ path, but the content available at this URL will be the original one.

Parameters:

  • ids (Array<String>) —

    Notification IDs.

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

    the optional parameters

Returns:



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

def get_notifications_detailed_translated_v1(ids, opts = {})
  data, _status_code, _headers = get_notifications_detailed_translated_v1_with_http_info(ids, opts)
  data
end

#get_notifications_detailed_translated_v1_with_http_info(ids, opts = {}) ⇒ Array<(DomainNotificationDetailsResponseV1, Integer, Hash)>

Get detailed notifications based on their IDs. These include the translated raw intelligence content that generated the match or part of it. Get detailed notifications based on their IDs. These include the translated raw intelligence content that generated the match or part of it. This API endpoint will return translated notification content. The only target language available is English. A single notification can be translated per request. In case the item&#39;s content is only partial, a URL is provided under the resource&#39;s &#39;details.full_content_url&#39; path, but the content available at this URL will be the original one.

Parameters:

  • ids (Array<String>) —

    Notification IDs.

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

    the optional parameters

Returns:



820
821
822
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
 
# File 'lib/crimson-falcon/api/recon.rb', line 820

def get_notifications_detailed_translated_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.get_notifications_detailed_translated_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 Recon.get_notifications_detailed_translated_v1"
  end
  # resource path
  local_var_path = '/recon/entities/notifications-detailed-translated/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] || 'DomainNotificationDetailsResponseV1'

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

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

#get_notifications_detailed_v1(ids, opts = {}) ⇒ DomainNotificationDetailsResponseV1

Get detailed notifications based on their IDs. These include the raw intelligence content that generated the match or part of it. Get detailed notifications based on their IDs. These include the raw intelligence content that generated the match or part of it. In case the content is only partial, a URL is provided under the resource’s ‘details.full_content_url’ path. When present, use this URL to retrieve the full raw text content of the item. Please note this URL has a limited TTL. To get a fresh valid one, perform a new call to this API endpoint.

Parameters:

  • ids (Array<String>) —

    Notification IDs.

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

    the optional parameters

Returns:



874
875
876
877
 
# File 'lib/crimson-falcon/api/recon.rb', line 874

def get_notifications_detailed_v1(ids, opts = {})
  data, _status_code, _headers = get_notifications_detailed_v1_with_http_info(ids, opts)
  data
end

#get_notifications_detailed_v1_with_http_info(ids, opts = {}) ⇒ Array<(DomainNotificationDetailsResponseV1, Integer, Hash)>

Get detailed notifications based on their IDs. These include the raw intelligence content that generated the match or part of it. Get detailed notifications based on their IDs. These include the raw intelligence content that generated the match or part of it. In case the content is only partial, a URL is provided under the resource&#39;s &#39;details.full_content_url&#39; path. When present, use this URL to retrieve the full raw text content of the item. Please note this URL has a limited TTL. To get a fresh valid one, perform a new call to this API endpoint.

Parameters:

  • ids (Array<String>) —

    Notification IDs.

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

    the optional parameters

Returns:



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

def get_notifications_detailed_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.get_notifications_detailed_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 Recon.get_notifications_detailed_v1"
  end
  # resource path
  local_var_path = '/recon/entities/notifications-detailed/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] || 'DomainNotificationDetailsResponseV1'

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

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

#get_notifications_exposed_data_records_v1(ids, opts = {}) ⇒ ApiNotificationExposedDataRecordEntitiesResponseV1

Get notifications exposed data records based on their IDs. IDs can be retrieved using the GET /queries/notifications-exposed-data-records/v1 endpoint. The associate notification can be fetched using the /entities/notifications/v* endpoints

Parameters:

  • ids (Array<String>) —

    Notification exposed records IDs.

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

    the optional parameters

Returns:



937
938
939
940
 
# File 'lib/crimson-falcon/api/recon.rb', line 937

def get_notifications_exposed_data_records_v1(ids, opts = {})
  data, _status_code, _headers = get_notifications_exposed_data_records_v1_with_http_info(ids, opts)
  data
end

#get_notifications_exposed_data_records_v1_with_http_info(ids, opts = {}) ⇒ Array<(ApiNotificationExposedDataRecordEntitiesResponseV1, Integer, Hash)>

Get notifications exposed data records based on their IDs. IDs can be retrieved using the GET /queries/notifications-exposed-data-records/v1 endpoint. The associate notification can be fetched using the /entities/notifications/v* endpoints

Parameters:

  • ids (Array<String>) —

    Notification exposed records IDs.

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

    the optional parameters

Returns:



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

def get_notifications_exposed_data_records_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.get_notifications_exposed_data_records_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 Recon.get_notifications_exposed_data_records_v1"
  end
  # resource path
  local_var_path = '/recon/entities/notifications-exposed-data-records/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] || 'ApiNotificationExposedDataRecordEntitiesResponseV1'

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

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

#get_notifications_translated_v1(ids, opts = {}) ⇒ DomainNotificationEntitiesResponseV1

Get notifications based on their IDs. IDs can be retrieved using the GET /queries/notifications/v1 endpoint. This endpoint will return translated notification content. The only target language available is English.

Parameters:

  • ids (Array<String>) —

    Notification IDs.

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

    the optional parameters

Returns:



999
1000
1001
1002
 
# File 'lib/crimson-falcon/api/recon.rb', line 999

def get_notifications_translated_v1(ids, opts = {})
  data, _status_code, _headers = get_notifications_translated_v1_with_http_info(ids, opts)
  data
end

#get_notifications_translated_v1_with_http_info(ids, opts = {}) ⇒ Array<(DomainNotificationEntitiesResponseV1, Integer, Hash)>

Get notifications based on their IDs. IDs can be retrieved using the GET /queries/notifications/v1 endpoint. This endpoint will return translated notification content. The only target language available is English.

Parameters:

  • ids (Array<String>) —

    Notification IDs.

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

    the optional parameters

Returns:



1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
 
# File 'lib/crimson-falcon/api/recon.rb', line 1008

def get_notifications_translated_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.get_notifications_translated_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 Recon.get_notifications_translated_v1"
  end
  # resource path
  local_var_path = '/recon/entities/notifications-translated/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] || 'DomainNotificationEntitiesResponseV1'

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

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

#get_notifications_v1(ids, opts = {}) ⇒ DomainNotificationEntitiesResponseV1

Get notifications based on their IDs. IDs can be retrieved using the GET /queries/notifications/v1 endpoint.

Parameters:

  • ids (Array<String>) —

    Notification IDs.

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

    the optional parameters

Returns:



1061
1062
1063
1064
 
# File 'lib/crimson-falcon/api/recon.rb', line 1061

def get_notifications_v1(ids, opts = {})
  data, _status_code, _headers = get_notifications_v1_with_http_info(ids, opts)
  data
end

#get_notifications_v1_with_http_info(ids, opts = {}) ⇒ Array<(DomainNotificationEntitiesResponseV1, Integer, Hash)>

Get notifications based on their IDs. IDs can be retrieved using the GET /queries/notifications/v1 endpoint.

Parameters:

  • ids (Array<String>) —

    Notification IDs.

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

    the optional parameters

Returns:



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
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
 
# File 'lib/crimson-falcon/api/recon.rb', line 1070

def get_notifications_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.get_notifications_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 Recon.get_notifications_v1"
  end
  # resource path
  local_var_path = '/recon/entities/notifications/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] || 'DomainNotificationEntitiesResponseV1'

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

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

#get_rules_v1(ids, opts = {}) ⇒ DomainRulesEntitiesResponseV1

Get monitoring rules based on their IDs. IDs can be retrieved using the GET /queries/rules/v1 endpoint.

Parameters:

  • ids (Array<String>) —

    IDs of rules.

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

    the optional parameters

Returns:



1123
1124
1125
1126
 
# File 'lib/crimson-falcon/api/recon.rb', line 1123

def get_rules_v1(ids, opts = {})
  data, _status_code, _headers = get_rules_v1_with_http_info(ids, opts)
  data
end

#get_rules_v1_with_http_info(ids, opts = {}) ⇒ Array<(DomainRulesEntitiesResponseV1, Integer, Hash)>

Get monitoring rules based on their IDs. IDs can be retrieved using the GET /queries/rules/v1 endpoint.

Parameters:

  • ids (Array<String>) —

    IDs of rules.

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

    the optional parameters

Returns:



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
1178
1179
 
# File 'lib/crimson-falcon/api/recon.rb', line 1132

def get_rules_v1_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.get_rules_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 Recon.get_rules_v1"
  end
  # resource path
  local_var_path = '/recon/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] || 'DomainRulesEntitiesResponseV1'

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

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

#preview_rule_v1(body, opts = {}) ⇒ DomainAggregatesResponse

Preview rules notification count and distribution. This will return aggregations on: channel, count, site.

Parameters:

Returns:



1185
1186
1187
1188
 
# File 'lib/crimson-falcon/api/recon.rb', line 1185

def preview_rule_v1(body, opts = {})
  data, _status_code, _headers = preview_rule_v1_with_http_info(body, opts)
  data
end

#preview_rule_v1_with_http_info(body, opts = {}) ⇒ Array<(DomainAggregatesResponse, Integer, Hash)>

Preview rules notification count and distribution. This will return aggregations on: channel, count, site.

Parameters:

Returns:

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

    DomainAggregatesResponse data, response status code and response headers



1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
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
 
# File 'lib/crimson-falcon/api/recon.rb', line 1194

def preview_rule_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.preview_rule_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 Recon.preview_rule_v1"
  end
  # resource path
  local_var_path = '/recon/aggregates/rules-preview/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] || 'DomainAggregatesResponse'

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

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

#query_actions_v1(opts = {}) ⇒ DomainQueryResponse

Query actions based on provided criteria. Use the IDs from this response to get the action entities on GET /entities/actions/v1.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

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

  • :limit (Integer) —

    Number of IDs to return. Offset + limit should NOT be above 10K.

  • :sort (String) —

    Possible order by fields: created_timestamp, updated_timestamp. Ex: &#39;updated_timestamp|desc&#39;.

  • :filter (String) —

    FQL query to filter actions by. Possible filter properties are: [id cid user_uuid rule_id type frequency content_format trigger_matchless recipients status created_timestamp updated_timestamp]

  • :q (String) —

    Free text search across all indexed fields

Returns:



1255
1256
1257
1258
 
# File 'lib/crimson-falcon/api/recon.rb', line 1255

def query_actions_v1(opts = {})
  data, _status_code, _headers = query_actions_v1_with_http_info(opts)
  data
end

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

Query actions based on provided criteria. Use the IDs from this response to get the action entities on GET /entities/actions/v1.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

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

  • :limit (Integer) —

    Number of IDs to return. Offset + limit should NOT be above 10K.

  • :sort (String) —

    Possible order by fields: created_timestamp, updated_timestamp. Ex: &#39;updated_timestamp|desc&#39;.

  • :filter (String) —

    FQL query to filter actions by. Possible filter properties are: [id cid user_uuid rule_id type frequency content_format trigger_matchless recipients status created_timestamp updated_timestamp]

  • :q (String) —

    Free text search across all indexed fields

Returns:

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

    DomainQueryResponse data, response status code and response headers



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

def query_actions_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.query_actions_v1 ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling Recon.query_actions_v1, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling Recon.query_actions_v1, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/recon/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?
  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 => :"Recon.query_actions_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: Recon#query_actions_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_notifications_exposed_data_records_v1(opts = {}) ⇒ DomainQueryResponse

Query notifications exposed data records based on provided criteria. Use the IDs from this response to get the notification +entities on GET /entities/notifications-exposed-data-records/v1

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

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

  • :limit (Integer) —

    Number of IDs to return. Offset + limit should NOT be above 10K.

  • :sort (String) —

    Possible order by fields: created_date, updated_date. Ex: &#39;updated_date|desc&#39;.

  • :filter (String) —

    FQL query to filter notifications by. Possible filter properties are: [id cid user_uuid created_date exposure_date rule.id rule.name rule.topic notification_id notification_group_id source_category site site_id author author_id user_id user_name credentials_url credentials_domain credentials_ip email domain hash_type display_name full_name user_ip phone_number company job_position file.name file.complete_data_set file.download_urls location.postal_code location.city location.state location.federal_district location.federal_admin_region location.country_code social.twitter_id social.facebook_id social.vk_id social.vk_token social.aim_id social.icq_id social.msn_id social.instagram_id social.skype_id financial.credit_card financial.bank_account financial.crypto_currency_addresses login_id credential_status _all bot.operating_system.hardware_id bot.bot_id]

  • :q (String) —

    Free text search across all indexed fields.

Returns:



1333
1334
1335
1336
 
# File 'lib/crimson-falcon/api/recon.rb', line 1333

def query_notifications_exposed_data_records_v1(opts = {})
  data, _status_code, _headers = query_notifications_exposed_data_records_v1_with_http_info(opts)
  data
end

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

Query notifications exposed data records based on provided criteria. Use the IDs from this response to get the notification +entities on GET /entities/notifications-exposed-data-records/v1

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

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

  • :limit (Integer) —

    Number of IDs to return. Offset + limit should NOT be above 10K.

  • :sort (String) —

    Possible order by fields: created_date, updated_date. Ex: &#39;updated_date|desc&#39;.

  • :filter (String) —

    FQL query to filter notifications by. Possible filter properties are: [id cid user_uuid created_date exposure_date rule.id rule.name rule.topic notification_id notification_group_id source_category site site_id author author_id user_id user_name credentials_url credentials_domain credentials_ip email domain hash_type display_name full_name user_ip phone_number company job_position file.name file.complete_data_set file.download_urls location.postal_code location.city location.state location.federal_district location.federal_admin_region location.country_code social.twitter_id social.facebook_id social.vk_id social.vk_token social.aim_id social.icq_id social.msn_id social.instagram_id social.skype_id financial.credit_card financial.bank_account financial.crypto_currency_addresses login_id credential_status _all bot.operating_system.hardware_id bot.bot_id]

  • :q (String) —

    Free text search across all indexed fields.

Returns:

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

    DomainQueryResponse data, response status code and response headers



1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
 
# File 'lib/crimson-falcon/api/recon.rb', line 1346

def query_notifications_exposed_data_records_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.query_notifications_exposed_data_records_v1 ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling Recon.query_notifications_exposed_data_records_v1, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling Recon.query_notifications_exposed_data_records_v1, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/recon/queries/notifications-exposed-data-records/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 => :"Recon.query_notifications_exposed_data_records_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: Recon#query_notifications_exposed_data_records_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_notifications_v1(opts = {}) ⇒ DomainQueryResponse

Query notifications based on provided criteria. Use the IDs from this response to get the notification entities on GET /entities/notifications/v1, GET /entities/notifications-detailed/v1, GET /entities/notifications-translated/v1 or GET /entities/notifications-detailed-translated/v1.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

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

  • :limit (Integer) —

    Number of IDs to return. Offset + limit should NOT be above 10K.

  • :sort (String) —

    Possible order by fields: &#x60;created_date&#x60;, &#x60;updated_date&#x60;. Ex: &#x60;updated_date|desc&#x60;.

  • :filter (String) —

    FQL query to filter notifications by. Possible filter properties are: [id cid user_uuid status rule_id rule_name rule_topic rule_priority item_type item_site typosquatting.id typosquatting.unicode_format typosquatting.punycode_format typosquatting.parent_domain.id typosquatting.parent_domain.unicode_format typosquatting.parent_domain.punycode_format typosquatting.base_domain.id typosquatting.base_domain.unicode_format typosquatting.base_domain.punycode_format typosquatting.base_domain.is_registered typosquatting.base_domain.whois.registrar.name typosquatting.base_domain.whois.registrar.status typosquatting.base_domain.whois.registrant.email typosquatting.base_domain.whois.registrant.name typosquatting.base_domain.whois.registrant.org typosquatting.base_domain.whois.name_servers created_date updated_date assigned_to_uuid breach_summary.credential_statuses breach_summary.is_retroactively_deduped]

  • :q (String) —

    Free text search across all indexed fields.

Returns:



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

def query_notifications_v1(opts = {})
  data, _status_code, _headers = query_notifications_v1_with_http_info(opts)
  data
end

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

Query notifications based on provided criteria. Use the IDs from this response to get the notification entities on GET /entities/notifications/v1, GET /entities/notifications-detailed/v1, GET /entities/notifications-translated/v1 or GET /entities/notifications-detailed-translated/v1.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

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

  • :limit (Integer) —

    Number of IDs to return. Offset + limit should NOT be above 10K.

  • :sort (String) —

    Possible order by fields: &#x60;created_date&#x60;, &#x60;updated_date&#x60;. Ex: &#x60;updated_date|desc&#x60;.

  • :filter (String) —

    FQL query to filter notifications by. Possible filter properties are: [id cid user_uuid status rule_id rule_name rule_topic rule_priority item_type item_site typosquatting.id typosquatting.unicode_format typosquatting.punycode_format typosquatting.parent_domain.id typosquatting.parent_domain.unicode_format typosquatting.parent_domain.punycode_format typosquatting.base_domain.id typosquatting.base_domain.unicode_format typosquatting.base_domain.punycode_format typosquatting.base_domain.is_registered typosquatting.base_domain.whois.registrar.name typosquatting.base_domain.whois.registrar.status typosquatting.base_domain.whois.registrant.email typosquatting.base_domain.whois.registrant.name typosquatting.base_domain.whois.registrant.org typosquatting.base_domain.whois.name_servers created_date updated_date assigned_to_uuid breach_summary.credential_statuses breach_summary.is_retroactively_deduped]

  • :q (String) —

    Free text search across all indexed fields.

Returns:

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

    DomainQueryResponse data, response status code and response headers



1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
 
# File 'lib/crimson-falcon/api/recon.rb', line 1424

def query_notifications_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.query_notifications_v1 ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling Recon.query_notifications_v1, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling Recon.query_notifications_v1, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/recon/queries/notifications/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 => :"Recon.query_notifications_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: Recon#query_notifications_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_rules_v1(opts = {}) ⇒ DomainRuleQueryResponseV1

Query monitoring rules based on provided criteria. Use the IDs from this response to fetch the rules on /entities/rules/v1.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

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

  • :limit (Integer) —

    Number of IDs to return. Offset + limit should NOT be above 10K.

  • :sort (String) —

    Possible order by fields: created_timestamp,last_updated_timestamp,permissions,priority,template_priority,topic. Ex: &#x60;last_updated_timestamp|desc&#x60;.

  • :filter (String) —

    FQL query to filter rules by. Possible filter properties are: [id cid user_uuid topic priority permissions status filter breach_monitoring_enabled substring_matching_enabled created_timestamp last_updated_timestamp].

  • :q (String) —

    Free text search across all indexed fields.

  • :secondary_sort (String) —

    Possible order by fields: created_timestamp,last_updated_timestamp,permissions,priority,template_priority,topic. Ex: &#x60;last_updated_timestamp|desc&#x60;.

Returns:



1490
1491
1492
1493
 
# File 'lib/crimson-falcon/api/recon.rb', line 1490

def query_rules_v1(opts = {})
  data, _status_code, _headers = query_rules_v1_with_http_info(opts)
  data
end

#query_rules_v1_with_http_info(opts = {}) ⇒ Array<(DomainRuleQueryResponseV1, Integer, Hash)>

Query monitoring rules based on provided criteria. Use the IDs from this response to fetch the rules on /entities/rules/v1.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

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

  • :limit (Integer) —

    Number of IDs to return. Offset + limit should NOT be above 10K.

  • :sort (String) —

    Possible order by fields: created_timestamp,last_updated_timestamp,permissions,priority,template_priority,topic. Ex: &#x60;last_updated_timestamp|desc&#x60;.

  • :filter (String) —

    FQL query to filter rules by. Possible filter properties are: [id cid user_uuid topic priority permissions status filter breach_monitoring_enabled substring_matching_enabled created_timestamp last_updated_timestamp].

  • :q (String) —

    Free text search across all indexed fields.

  • :secondary_sort (String) —

    Possible order by fields: created_timestamp,last_updated_timestamp,permissions,priority,template_priority,topic. Ex: &#x60;last_updated_timestamp|desc&#x60;.

Returns:

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

    DomainRuleQueryResponseV1 data, response status code and response headers



1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
 
# File 'lib/crimson-falcon/api/recon.rb', line 1504

def query_rules_v1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.query_rules_v1 ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling Recon.query_rules_v1, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling Recon.query_rules_v1, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/recon/queries/rules/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[:'secondarySort'] = opts[:'secondary_sort'] if !opts[:'secondary_sort'].nil?

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

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

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

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

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

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

#update_action_v1(body, opts = {}) ⇒ DomainActionEntitiesResponseV1

Update an action for a monitoring rule.

Parameters:

Returns:



1566
1567
1568
1569
 
# File 'lib/crimson-falcon/api/recon.rb', line 1566

def update_action_v1(body, opts = {})
  data, _status_code, _headers = update_action_v1_with_http_info(body, opts)
  data
end

#update_action_v1_with_http_info(body, opts = {}) ⇒ Array<(DomainActionEntitiesResponseV1, Integer, Hash)>

Update an action for a monitoring rule.

Parameters:

Returns:



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

def update_action_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.update_action_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 Recon.update_action_v1"
  end
  # resource path
  local_var_path = '/recon/entities/actions/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] || 'DomainActionEntitiesResponseV1'

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

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

#update_notifications_v1(body, opts = {}) ⇒ DomainNotificationEntitiesResponseV1

Update notification status or assignee. Accepts bulk requests

Parameters:

Returns:



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

def update_notifications_v1(body, opts = {})
  data, _status_code, _headers = update_notifications_v1_with_http_info(body, opts)
  data
end

#update_notifications_v1_with_http_info(body, opts = {}) ⇒ Array<(DomainNotificationEntitiesResponseV1, Integer, Hash)>

Update notification status or assignee. Accepts bulk requests

Parameters:

Returns:



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

def update_notifications_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.update_notifications_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 Recon.update_notifications_v1"
  end
  # resource path
  local_var_path = '/recon/entities/notifications/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] || 'DomainNotificationEntitiesResponseV1'

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

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

#update_rules_v1(body, opts = {}) ⇒ DomainRulesEntitiesResponseV1

Update monitoring rules.

Parameters:

Returns:



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

def update_rules_v1(body, opts = {})
  data, _status_code, _headers = update_rules_v1_with_http_info(body, opts)
  data
end

#update_rules_v1_with_http_info(body, opts = {}) ⇒ Array<(DomainRulesEntitiesResponseV1, Integer, Hash)>

Update monitoring rules.

Parameters:

Returns:



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

def update_rules_v1_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Recon.update_rules_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 Recon.update_rules_v1"
  end
  # resource path
  local_var_path = '/recon/entities/rules/v1'

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

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

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

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

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

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

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