Class: Falcon::Filevantage

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Filevantage 



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

def api_client
  @api_client
end

Instance Method Details

#create_policies(body, opts = {}) ⇒ PoliciesResponse

Creates a new policy of the specified type. New policies are always added at the end of the precedence list for the provided policy type. After they are created, host and rule groups can be assigned, scheduled exclusions can be defined, and policy precedence can be set.



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

def create_policies(body, opts = {})
  data, _status_code, _headers = create_policies_with_http_info(body, opts)
  data
end

#create_policies_with_http_info(body, opts = {}) ⇒ Array<(PoliciesResponse, Integer, Hash)>

Creates a new policy of the specified type. New policies are always added at the end of the precedence list for the provided policy type. After they are created, host and rule groups can be assigned, scheduled exclusions can be defined, and policy precedence can be set.



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
103
104
105
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 54

def create_policies_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.create_policies ...'
  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 Filevantage.create_policies"
  end
  # resource path
  local_var_path = '/filevantage/entities/policies/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] || 'PoliciesResponse'

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

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

#create_rule_groups(body, opts = {}) ⇒ RulegroupsResponse

Creates a new rule group of the specified type. Individual rules can be assigned to a rule group after it has been created.



112
113
114
115
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 112

def create_rule_groups(body, opts = {})
  data, _status_code, _headers = create_rule_groups_with_http_info(body, opts)
  data
end

#create_rule_groups_with_http_info(body, opts = {}) ⇒ Array<(RulegroupsResponse, Integer, Hash)>

Creates a new rule group of the specified type. Individual rules can be assigned to a rule group after it has been created.



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
169
170
171
172
173
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 122

def create_rule_groups_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.create_rule_groups ...'
  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 Filevantage.create_rule_groups"
  end
  # resource path
  local_var_path = '/filevantage/entities/rule-groups/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] || 'RulegroupsResponse'

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

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

#create_rules(body, opts = {}) ⇒ RulegroupsRulesResponse

Creates a new rule configuration within the specified rule group. Creates a new rule configuration within the specified rule group.



180
181
182
183
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 180

def create_rules(body, opts = {})
  data, _status_code, _headers = create_rules_with_http_info(body, opts)
  data
end

#create_rules_with_http_info(body, opts = {}) ⇒ Array<(RulegroupsRulesResponse, Integer, Hash)>

Creates a new rule configuration within the specified rule group. Creates a new rule configuration within the specified rule group.



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 190

def create_rules_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.create_rules ...'
  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 Filevantage.create_rules"
  end
  # resource path
  local_var_path = '/filevantage/entities/rule-groups-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] || 'RulegroupsRulesResponse'

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

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

#create_scheduled_exclusions(body, opts = {}) ⇒ ScheduledexclusionsResponse

Creates a new scheduled exclusion configuration for the provided policy id. Creates a new scheduled exclusion configuration for the provided policy id.



248
249
250
251
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 248

def create_scheduled_exclusions(body, opts = {})
  data, _status_code, _headers = create_scheduled_exclusions_with_http_info(body, opts)
  data
end

#create_scheduled_exclusions_with_http_info(body, opts = {}) ⇒ Array<(ScheduledexclusionsResponse, Integer, Hash)>

Creates a new scheduled exclusion configuration for the provided policy id. Creates a new scheduled exclusion configuration for the provided policy id.



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
301
302
303
304
305
306
307
308
309
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 258

def create_scheduled_exclusions_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.create_scheduled_exclusions ...'
  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 Filevantage.create_scheduled_exclusions"
  end
  # resource path
  local_var_path = '/filevantage/entities/policy-scheduled-exclusions/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] || 'ScheduledexclusionsResponse'

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

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

#delete_policies(ids, opts = {}) ⇒ PoliciesDeleteResponse

Deletes 1 or more policies. Only disabled policies are allowed to be deleted.



316
317
318
319
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 316

def delete_policies(ids, opts = {})
  data, _status_code, _headers = delete_policies_with_http_info(ids, opts)
  data
end

#delete_policies_with_http_info(ids, opts = {}) ⇒ Array<(PoliciesDeleteResponse, Integer, Hash)>

Deletes 1 or more policies. Only disabled policies are allowed to be deleted.



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

def delete_policies_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.delete_policies ...'
  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 Filevantage.delete_policies"
  end
  # resource path
  local_var_path = '/filevantage/entities/policies/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] || 'PoliciesDeleteResponse'

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

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

#delete_rule_groups(ids, opts = {}) ⇒ RulegroupsDeleteResponse

Deletes 1 or more rule groups The rule groups represented by the provided ids and all rules that they contain will be deleted. Rule groups can only be deleted if they are not assigned to a policy.



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

def delete_rule_groups(ids, opts = {})
  data, _status_code, _headers = delete_rule_groups_with_http_info(ids, opts)
  data
end

#delete_rule_groups_with_http_info(ids, opts = {}) ⇒ Array<(RulegroupsDeleteResponse, Integer, Hash)>

Deletes 1 or more rule groups The rule groups represented by the provided ids and all rules that they contain will be deleted. Rule groups can only be deleted if they are not assigned to a policy.



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

def delete_rule_groups_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.delete_rule_groups ...'
  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 Filevantage.delete_rule_groups"
  end
  # resource path
  local_var_path = '/filevantage/entities/rule-groups/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] || 'RulegroupsDeleteResponse'

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

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

#delete_rules(rule_group_id, ids, opts = {}) ⇒ MsaspecQueryResponse

Deletes 1 or more rules from the specified rule group. Rules that match a provided id will be deleted from the provided rule group id.



445
446
447
448
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 445

def delete_rules(rule_group_id, ids, opts = {})
  data, _status_code, _headers = delete_rules_with_http_info(rule_group_id, ids, opts)
  data
end

#delete_rules_with_http_info(rule_group_id, ids, opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>

Deletes 1 or more rules from the specified rule group. Rules that match a provided id will be deleted from the provided rule group id.



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

def delete_rules_with_http_info(rule_group_id, ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.delete_rules ...'
  end
  # verify the required parameter 'rule_group_id' is set
  if @api_client.config.client_side_validation && rule_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_group_id' when calling Filevantage.delete_rules"
  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 Filevantage.delete_rules"
  end
  # resource path
  local_var_path = '/filevantage/entities/rule-groups-rules/v1'

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

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

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

#delete_scheduled_exclusions(policy_id, ids, opts = {}) ⇒ MsaspecQueryResponse

Deletes 1 or more scheduled exclusions from the provided policy id. Scheduled exclusions that match a provided id will be deleted from the provided policy id.



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

def delete_scheduled_exclusions(policy_id, ids, opts = {})
  data, _status_code, _headers = delete_scheduled_exclusions_with_http_info(policy_id, ids, opts)
  data
end

#delete_scheduled_exclusions_with_http_info(policy_id, ids, opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>

Deletes 1 or more scheduled exclusions from the provided policy id. Scheduled exclusions that match a provided id will be deleted from the provided policy id.



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/filevantage.rb', line 527

def delete_scheduled_exclusions_with_http_info(policy_id, ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.delete_scheduled_exclusions ...'
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling Filevantage.delete_scheduled_exclusions"
  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 Filevantage.delete_scheduled_exclusions"
  end
  # resource path
  local_var_path = '/filevantage/entities/policy-scheduled-exclusions/v1'

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

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

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

#get_actions_mixin0(ids, opts = {}) ⇒ ActionsGetActionResponse

Retrieves the processing results for 1 or more actions. The processing results of each action that match the provided ids will be returned.



586
587
588
589
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 586

def get_actions_mixin0(ids, opts = {})
  data, _status_code, _headers = get_actions_mixin0_with_http_info(ids, opts)
  data
end

#get_actions_mixin0_with_http_info(ids, opts = {}) ⇒ Array<(ActionsGetActionResponse, Integer, Hash)>

Retrieves the processing results for 1 or more actions. The processing results of each action that match the provided ids will be returned.



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 596

def get_actions_mixin0_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.get_actions_mixin0 ...'
  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 Filevantage.get_actions_mixin0"
  end
  # resource path
  local_var_path = '/filevantage/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] || 'ActionsGetActionResponse'

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

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

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

#get_changes(ids, opts = {}) ⇒ PublicGetChangesResponse

Retrieve information on changes Retrieve key attributes of Falcon FileVantage changes for the specified ids.



650
651
652
653
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 650

def get_changes(ids, opts = {})
  data, _status_code, _headers = get_changes_with_http_info(ids, opts)
  data
end

#get_changes_with_http_info(ids, opts = {}) ⇒ Array<(PublicGetChangesResponse, Integer, Hash)>

Retrieve information on changes Retrieve key attributes of Falcon FileVantage changes for the specified ids.



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 660

def get_changes_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.get_changes ...'
  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 Filevantage.get_changes"
  end
  if @api_client.config.client_side_validation && ids.length > 500
    fail ArgumentError, 'invalid value for "ids" when calling Filevantage.get_changes, number of items must be less than or equal to 500.'
  end

  if @api_client.config.client_side_validation && ids.length < 1
    fail ArgumentError, 'invalid value for "ids" when calling Filevantage.get_changes, number of items must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/filevantage/entities/changes/v2'

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

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

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

#get_contents(id, opts = {}) ⇒ ContentchangesChangeContentsResponse

Retrieves the content captured for the provided change id Retrieves the before and after change content for the provided change id.

Options Hash (opts):

  • :accept_encoding (String) —

    Providing the value of &#x60;gzip&#x60; compresses the response, otherwise the content is returned uncompressed.



723
724
725
726
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 723

def get_contents(id, opts = {})
  data, _status_code, _headers = get_contents_with_http_info(id, opts)
  data
end

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

Retrieves the content captured for the provided change id Retrieves the before and after change content for the provided change id.

Options Hash (opts):

  • :accept_encoding (String) —

    Providing the value of &#x60;gzip&#x60; compresses the response, otherwise the content is returned uncompressed.



734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 734

def get_contents_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.get_contents ...'
  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 Filevantage.get_contents"
  end
  # resource path
  local_var_path = '/filevantage/entities/change-content/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'])
  header_params[:'Accept-Encoding'] = opts[:'accept_encoding'] if !opts[:'accept_encoding'].nil?

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

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

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

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

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

#get_policies(ids, opts = {}) ⇒ PoliciesResponse

Retrieves the configuration for 1 or more policies. The configuration of each policy that match the provided id will be returned.



789
790
791
792
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 789

def get_policies(ids, opts = {})
  data, _status_code, _headers = get_policies_with_http_info(ids, opts)
  data
end

#get_policies_with_http_info(ids, opts = {}) ⇒ Array<(PoliciesResponse, Integer, Hash)>

Retrieves the configuration for 1 or more policies. The configuration of each policy that match the provided id will be returned.



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 799

def get_policies_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.get_policies ...'
  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 Filevantage.get_policies"
  end
  # resource path
  local_var_path = '/filevantage/entities/policies/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] || 'PoliciesResponse'

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

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

#get_rule_groups(ids, opts = {}) ⇒ RulegroupsResponse

Retrieves the rule group details for 1 or more rule groups. Full details of each rule group that matches a provided id will be returned in the response



853
854
855
856
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 853

def get_rule_groups(ids, opts = {})
  data, _status_code, _headers = get_rule_groups_with_http_info(ids, opts)
  data
end

#get_rule_groups_with_http_info(ids, opts = {}) ⇒ Array<(RulegroupsResponse, Integer, Hash)>

Retrieves the rule group details for 1 or more rule groups. Full details of each rule group that matches a provided id will be returned in the response



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 863

def get_rule_groups_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.get_rule_groups ...'
  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 Filevantage.get_rule_groups"
  end
  # resource path
  local_var_path = '/filevantage/entities/rule-groups/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] || 'RulegroupsResponse'

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

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

#get_rules(rule_group_id, ids, opts = {}) ⇒ RulegroupsRulesResponse

Retrieves the configuration for 1 or more rules. Rules within the provided rule group id that match a provided id will be returned within the response.



918
919
920
921
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 918

def get_rules(rule_group_id, ids, opts = {})
  data, _status_code, _headers = get_rules_with_http_info(rule_group_id, ids, opts)
  data
end

#get_rules_with_http_info(rule_group_id, ids, opts = {}) ⇒ Array<(RulegroupsRulesResponse, Integer, Hash)>

Retrieves the configuration for 1 or more rules. Rules within the provided rule group id that match a provided id will be returned within the response.



929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 929

def get_rules_with_http_info(rule_group_id, ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.get_rules ...'
  end
  # verify the required parameter 'rule_group_id' is set
  if @api_client.config.client_side_validation && rule_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_group_id' when calling Filevantage.get_rules"
  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 Filevantage.get_rules"
  end
  # resource path
  local_var_path = '/filevantage/entities/rule-groups-rules/v1'

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

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

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

#get_scheduled_exclusions(policy_id, ids, opts = {}) ⇒ ScheduledexclusionsResponse

Retrieves the configuration of 1 or more scheduled exclusions from the provided policy id. Full details of each each scheduled exclusion that match a provided id will be returned in the response.



989
990
991
992
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 989

def get_scheduled_exclusions(policy_id, ids, opts = {})
  data, _status_code, _headers = get_scheduled_exclusions_with_http_info(policy_id, ids, opts)
  data
end

#get_scheduled_exclusions_with_http_info(policy_id, ids, opts = {}) ⇒ Array<(ScheduledexclusionsResponse, Integer, Hash)>

Retrieves the configuration of 1 or more scheduled exclusions from the provided policy id. Full details of each each scheduled exclusion that match a provided id will be returned in the response.



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

def get_scheduled_exclusions_with_http_info(policy_id, ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.get_scheduled_exclusions ...'
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling Filevantage.get_scheduled_exclusions"
  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 Filevantage.get_scheduled_exclusions"
  end
  # resource path
  local_var_path = '/filevantage/entities/policy-scheduled-exclusions/v1'

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

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

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

#high_volume_query_changes(opts = {}) ⇒ ChangesHighVolumeQueryResponse

Returns 1 or more change ids Returns a list of Falcon FileVantage change ids filtered, sorted and limited by the query parameters provided. It can retrieve an unlimited number of results using multiple requests.

Options Hash (opts):

  • :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 a value for the &#x60;after&#x60; token. On subsequent requests provide the &#x60;after&#x60; token value from the previous response to continue pagination from where you left. If the response returns an empty &#x60;after&#x60; token it means there are no more results to return.

  • :limit (Integer) —

    The maximum number of ids to return. Defaults to &#x60;100&#x60; if not specified. The maximum number of results that can be returned in a single call is &#x60;5000&#x60;. (default to 100)

  • :sort (String) —

    Sort results using options like: - &#x60;action_timestamp&#x60; (timestamp of the change occurrence) Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). For example: &#x60;action_timestamp|asc&#x60;. Defaults to &#x60;action_timestamp|desc&#x60; no value is specified. The full list of allowed sorting options can be reviewed in our API documentation. (default to ‘action_timestamp|desc’)

  • :filter (String) —

    Filter changes using a query in Falcon Query Language (FQL). Common filter options include: - &#x60;host.name&#x60; - &#x60;action_timestamp&#x60; The full list of allowed filter parameters can be reviewed in our API documentation.



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

def high_volume_query_changes(opts = {})
  data, _status_code, _headers = high_volume_query_changes_with_http_info(opts)
  data
end

#high_volume_query_changes_with_http_info(opts = {}) ⇒ Array<(ChangesHighVolumeQueryResponse, Integer, Hash)>

Returns 1 or more change ids Returns a list of Falcon FileVantage change ids filtered, sorted and limited by the query parameters provided. It can retrieve an unlimited number of results using multiple requests.

Options Hash (opts):

  • :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 a value for the &#x60;after&#x60; token. On subsequent requests provide the &#x60;after&#x60; token value from the previous response to continue pagination from where you left. If the response returns an empty &#x60;after&#x60; token it means there are no more results to return.

  • :limit (Integer) —

    The maximum number of ids to return. Defaults to &#x60;100&#x60; if not specified. The maximum number of results that can be returned in a single call is &#x60;5000&#x60;. (default to 100)

  • :sort (String) —

    Sort results using options like: - &#x60;action_timestamp&#x60; (timestamp of the change occurrence) Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). For example: &#x60;action_timestamp|asc&#x60;. Defaults to &#x60;action_timestamp|desc&#x60; no value is specified. The full list of allowed sorting options can be reviewed in our API documentation. (default to ‘action_timestamp|desc’)

  • :filter (String) —

    Filter changes using a query in Falcon Query Language (FQL). Common filter options include: - &#x60;host.name&#x60; - &#x60;action_timestamp&#x60; The full list of allowed filter parameters can be reviewed in our API documentation.



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
1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1075

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

  # resource path
  local_var_path = '/filevantage/queries/changes/v3'

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

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

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

#query_actions_mixin0(opts = {}) ⇒ MsaspecQueryResponse

Returns one or more action ids Returns the list of action ids filtered, sorted, and limited to the query parameters provided.

Options Hash (opts):

  • :offset (Integer) —

    The first action index to return in the response. If not provided it will default to &#39;0&#39;. Use with the &#x60;limit&#x60; parameter to manage pagination of results.

  • :limit (Integer) —

    The maximum number of actions to return in the response (default: 100; max: 500). Use with the &#x60;offset&#x60; parameter to manage pagination of results

  • :sort (String) —

    The sort expression that should be used to sort the results (e.g. created_date|desc)

  • :filter (String) —

    Filter changes using a query in Falcon Query Language (FQL). Common filter options include: - &#x60;status&#x60; - &#x60;operation_type&#x60; The full list of allowed filter parameters can be reviewed in our API documentation.



1135
1136
1137
1138
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1135

def query_actions_mixin0(opts = {})
  data, _status_code, _headers = query_actions_mixin0_with_http_info(opts)
  data
end

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

Returns one or more action ids Returns the list of action ids filtered, sorted, and limited to the query parameters provided.

Options Hash (opts):

  • :offset (Integer) —

    The first action index to return in the response. If not provided it will default to &#39;0&#39;. Use with the &#x60;limit&#x60; parameter to manage pagination of results.

  • :limit (Integer) —

    The maximum number of actions to return in the response (default: 100; max: 500). Use with the &#x60;offset&#x60; parameter to manage pagination of results

  • :sort (String) —

    The sort expression that should be used to sort the results (e.g. created_date|desc)

  • :filter (String) —

    Filter changes using a query in Falcon Query Language (FQL). Common filter options include: - &#x60;status&#x60; - &#x60;operation_type&#x60; The full list of allowed filter parameters can be reviewed in our API documentation.



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

def query_actions_mixin0_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.query_actions_mixin0 ...'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling Filevantage.query_actions_mixin0, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/filevantage/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?

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

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

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

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

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

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

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

#query_changes(opts = {}) ⇒ MsaspecQueryResponse

Returns 1 or more change ids Returns a list of Falcon FileVantage change ids filtered, sorted and limited by the query parameters provided. Using this endpoint you can retrieve up to 10000 results by using pagination with multiple requests. If you need to retrieve more than 10000 results consider using the /queries/changes/v3 endpoint

Options Hash (opts):

  • :offset (Integer) —

    The offset to start retrieving records from. Defaults to &#x60;0&#x60; if not specified. (default to 0)

  • :limit (Integer) —

    The maximum number of ids to return. Defaults to &#x60;100&#x60; if not specified. The maximum number of results that can be returned in a single call is &#x60;500&#x60;. (default to 100)

  • :sort (String) —

    Sort results using options like: - &#x60;action_timestamp&#x60; (timestamp of the change occurrence) Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). For example: &#x60;action_timestamp|asc&#x60;. The full list of allowed sorting options can be reviewed in our API documentation.

  • :filter (String) —

    Filter changes using a query in Falcon Query Language (FQL). Common filter options include: - &#x60;host.name&#x60; - &#x60;action_timestamp&#x60; The full list of allowed filter parameters can be reviewed in our API documentation.



1208
1209
1210
1211
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1208

def query_changes(opts = {})
  data, _status_code, _headers = query_changes_with_http_info(opts)
  data
end

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

Returns 1 or more change ids Returns a list of Falcon FileVantage change ids filtered, sorted and limited by the query parameters provided. Using this endpoint you can retrieve up to &#x60;10000&#x60; results by using pagination with multiple requests. If you need to retrieve more than &#x60;10000&#x60; results consider using the &#x60;/queries/changes/v3&#x60; endpoint

Options Hash (opts):

  • :offset (Integer) —

    The offset to start retrieving records from. Defaults to &#x60;0&#x60; if not specified. (default to 0)

  • :limit (Integer) —

    The maximum number of ids to return. Defaults to &#x60;100&#x60; if not specified. The maximum number of results that can be returned in a single call is &#x60;500&#x60;. (default to 100)

  • :sort (String) —

    Sort results using options like: - &#x60;action_timestamp&#x60; (timestamp of the change occurrence) Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending). For example: &#x60;action_timestamp|asc&#x60;. The full list of allowed sorting options can be reviewed in our API documentation.

  • :filter (String) —

    Filter changes using a query in Falcon Query Language (FQL). Common filter options include: - &#x60;host.name&#x60; - &#x60;action_timestamp&#x60; The full list of allowed filter parameters can be reviewed in our API documentation.



1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1221

def query_changes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.query_changes ...'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling Filevantage.query_changes, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling Filevantage.query_changes, must be smaller than or equal to 500.'
  end

  # resource path
  local_var_path = '/filevantage/queries/changes/v2'

  # 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?

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

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

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

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

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

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

#query_policies(type, opts = {}) ⇒ MsaspecQueryResponse

Retrieve the ids of all policies that are assigned the provided policy type. Policy ids will be returned sorted by a precedence order of ascending when a sort parameter is not provided.

Options Hash (opts):

  • :offset (Integer) —

    The offset to start retrieving records from. Defaults to 0 if not specified.

  • :limit (Integer) —

    The maximum number of ids to return. Defaults to 100 if not specified. The maximum number of results that can be returned in a single call is 500.

  • :sort (String) —

    Sort the returned ids based on one of the following properties: &#x60;precedence&#x60;, &#x60;created_timestamp&#x60; or &#x60;modified_timestamp&#x60; Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending); for example: &#x60;precedence|asc&#x60;.



1285
1286
1287
1288
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1285

def query_policies(type, opts = {})
  data, _status_code, _headers = query_policies_with_http_info(type, opts)
  data
end

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

Retrieve the ids of all policies that are assigned the provided policy type. Policy ids will be returned sorted by a &#x60;precedence&#x60; order of ascending when a &#x60;sort&#x60; parameter is not provided.

Options Hash (opts):

  • :offset (Integer) —

    The offset to start retrieving records from. Defaults to 0 if not specified.

  • :limit (Integer) —

    The maximum number of ids to return. Defaults to 100 if not specified. The maximum number of results that can be returned in a single call is 500.

  • :sort (String) —

    Sort the returned ids based on one of the following properties: &#x60;precedence&#x60;, &#x60;created_timestamp&#x60; or &#x60;modified_timestamp&#x60; Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending); for example: &#x60;precedence|asc&#x60;.



1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1298

def query_policies_with_http_info(type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.query_policies ...'
  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 Filevantage.query_policies"
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling Filevantage.query_policies, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/filevantage/queries/policies/v1'

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

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

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

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

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

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

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

#query_rule_groups(type, opts = {}) ⇒ MsaspecQueryResponse

Retrieve the ids of all rule groups that are of the provided rule group type. Rule group ids will be returned sorted by created_timestamp order if a sort parameter is not provided

Options Hash (opts):

  • :offset (Integer) —

    The offset to start retrieving records from. Defaults to 0 if not specified.

  • :limit (Integer) —

    The maximum number of ids to return. Defaults to 100 if not specified. The maximum number of results that can be returned in a single call is 500.

  • :sort (String) —

    Sort the returned ids based on one of the following properties: &#x60;created_timestamp&#x60; or &#x60;modified_timestamp&#x60; Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending); for example: &#x60;created_timestamp|asc&#x60;.



1362
1363
1364
1365
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1362

def query_rule_groups(type, opts = {})
  data, _status_code, _headers = query_rule_groups_with_http_info(type, opts)
  data
end

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

Retrieve the ids of all rule groups that are of the provided rule group type. Rule group ids will be returned sorted by &#x60;created_timestamp&#x60; order if a &#x60;sort&#x60; parameter is not provided

Options Hash (opts):

  • :offset (Integer) —

    The offset to start retrieving records from. Defaults to 0 if not specified.

  • :limit (Integer) —

    The maximum number of ids to return. Defaults to 100 if not specified. The maximum number of results that can be returned in a single call is 500.

  • :sort (String) —

    Sort the returned ids based on one of the following properties: &#x60;created_timestamp&#x60; or &#x60;modified_timestamp&#x60; Sort either &#x60;asc&#x60; (ascending) or &#x60;desc&#x60; (descending); for example: &#x60;created_timestamp|asc&#x60;.



1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1375

def query_rule_groups_with_http_info(type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.query_rule_groups ...'
  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 Filevantage.query_rule_groups"
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling Filevantage.query_rule_groups, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/filevantage/queries/rule-groups/v1'

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

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

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

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

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

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

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

#query_scheduled_exclusions(policy_id, opts = {}) ⇒ MsaspecQueryResponse

Retrieve the ids of all scheduled exclusions contained within the provided policy id. Retrieve the ids of all scheduled exclusions contained within the provided policy id



1436
1437
1438
1439
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1436

def query_scheduled_exclusions(policy_id, opts = {})
  data, _status_code, _headers = query_scheduled_exclusions_with_http_info(policy_id, opts)
  data
end

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

Retrieve the ids of all scheduled exclusions contained within the provided policy id. Retrieve the ids of all scheduled exclusions contained within the provided policy id



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
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1446

def query_scheduled_exclusions_with_http_info(policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.query_scheduled_exclusions ...'
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling Filevantage.query_scheduled_exclusions"
  end
  # resource path
  local_var_path = '/filevantage/queries/policy-scheduled-exclusions/v1'

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

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

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

#signal_changes_external(body, opts = {}) ⇒ WorkflowResponse

Initiates workflows for the provided change ids Provides the ability to initiate workflows for the specified change ids. Only 100 change ids can be provided per workflow request.



1500
1501
1502
1503
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1500

def signal_changes_external(body, opts = {})
  data, _status_code, _headers = signal_changes_external_with_http_info(body, opts)
  data
end

#signal_changes_external_with_http_info(body, opts = {}) ⇒ Array<(WorkflowResponse, Integer, Hash)>

Initiates workflows for the provided change ids Provides the ability to initiate workflows for the specified change ids. Only 100 change ids can be provided per workflow request.



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

def signal_changes_external_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.signal_changes_external ...'
  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 Filevantage.signal_changes_external"
  end
  # resource path
  local_var_path = '/filevantage/entities/workflow/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] || 'WorkflowResponse'

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

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

#start_actions(body, opts = {}) ⇒ ActionsActionResponse

Initiates the specified action on the provided change ids Initiates the suppression, unsuppression, or purging of the provided change ids. Note that only 1 action may be initiated and active at a time.



1568
1569
1570
1571
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1568

def start_actions(body, opts = {})
  data, _status_code, _headers = start_actions_with_http_info(body, opts)
  data
end

#start_actions_with_http_info(body, opts = {}) ⇒ Array<(ActionsActionResponse, Integer, Hash)>

Initiates the specified action on the provided change ids Initiates the suppression, unsuppression, or purging of the provided change ids. Note that only 1 action may be initiated and active at a time.



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
1627
1628
1629
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1578

def start_actions_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.start_actions ...'
  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 Filevantage.start_actions"
  end
  # resource path
  local_var_path = '/filevantage/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] || 'ActionsActionResponse'

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

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

#update_policies(body, opts = {}) ⇒ PoliciesResponse

Updates the general information of the provided policy. Only name, description, and enabled status of the policy is allowed to be update. Rule and host group assignment is performed via their respective patch end points.



1636
1637
1638
1639
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1636

def update_policies(body, opts = {})
  data, _status_code, _headers = update_policies_with_http_info(body, opts)
  data
end

#update_policies_with_http_info(body, opts = {}) ⇒ Array<(PoliciesResponse, Integer, Hash)>

Updates the general information of the provided policy. Only name, description, and enabled status of the policy is allowed to be update. Rule and host group assignment is performed via their respective patch end points.



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

def update_policies_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.update_policies ...'
  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 Filevantage.update_policies"
  end
  # resource path
  local_var_path = '/filevantage/entities/policies/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] || 'PoliciesResponse'

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

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

#update_policy_host_groups(policy_id, action, ids, opts = {}) ⇒ PoliciesResponse

Manage host groups assigned to a policy. Manage host groups assigned to a policy.



1706
1707
1708
1709
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1706

def update_policy_host_groups(policy_id, action, ids, opts = {})
  data, _status_code, _headers = update_policy_host_groups_with_http_info(policy_id, action, ids, opts)
  data
end

#update_policy_host_groups_with_http_info(policy_id, action, ids, opts = {}) ⇒ Array<(PoliciesResponse, Integer, Hash)>

Manage host groups assigned to a policy. Manage host groups assigned to a policy.



1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1718

def update_policy_host_groups_with_http_info(policy_id, action, ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.update_policy_host_groups ...'
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling Filevantage.update_policy_host_groups"
  end
  # verify the required parameter 'action' is set
  if @api_client.config.client_side_validation && action.nil?
    fail ArgumentError, "Missing the required parameter 'action' when calling Filevantage.update_policy_host_groups"
  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 Filevantage.update_policy_host_groups"
  end
  # resource path
  local_var_path = '/filevantage/entities/policies-host-groups/v1'

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

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

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

#update_policy_precedence(ids, type, opts = {}) ⇒ PoliciesPrecedenceResponse

Updates the policy precedence for all policies of a specific type. Requests that do not represent all ids of the provided policy type will not be processed.



1783
1784
1785
1786
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1783

def update_policy_precedence(ids, type, opts = {})
  data, _status_code, _headers = update_policy_precedence_with_http_info(ids, type, opts)
  data
end

#update_policy_precedence_with_http_info(ids, type, opts = {}) ⇒ Array<(PoliciesPrecedenceResponse, Integer, Hash)>

Updates the policy precedence for all policies of a specific type. Requests that do not represent all ids of the provided policy type will not be processed.



1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1794

def update_policy_precedence_with_http_info(ids, type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.update_policy_precedence ...'
  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 Filevantage.update_policy_precedence"
  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 Filevantage.update_policy_precedence"
  end
  # resource path
  local_var_path = '/filevantage/entities/policies-precedence/v1'

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

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

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

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

#update_policy_rule_groups(policy_id, action, ids, opts = {}) ⇒ PoliciesResponse

Manage the rule groups assigned to the policy or set the rule group precedence for all rule groups within the policy. Manage the rule groups assigned to the policy. Rule groups must be of the same type as the policy they are being added: * WindowsRegistry and WindowsFiles groups can only be added to a Windows policy. * LinuxFiles groups can only be added to a Linux policy. * MacFiles groups can only be added to a Mac policy. When setting rule group precedence, the precedence for all rule group ids within the policy must be provided.



1855
1856
1857
1858
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1855

def update_policy_rule_groups(policy_id, action, ids, opts = {})
  data, _status_code, _headers = update_policy_rule_groups_with_http_info(policy_id, action, ids, opts)
  data
end

#update_policy_rule_groups_with_http_info(policy_id, action, ids, opts = {}) ⇒ Array<(PoliciesResponse, Integer, Hash)>

Manage the rule groups assigned to the policy or set the rule group precedence for all rule groups within the policy. Manage the rule groups assigned to the policy. Rule groups must be of the same type as the policy they are being added: * &#x60;WindowsRegistry&#x60; and &#x60;WindowsFiles&#x60; groups can only be added to a &#x60;Windows&#x60; policy. * &#x60;LinuxFiles&#x60; groups can only be added to a &#x60;Linux&#x60; policy. * &#x60;MacFiles&#x60; groups can only be added to a &#x60;Mac&#x60; policy. When setting rule group precedence, the precedence for &#x60;all&#x60; rule group ids within the policy must be provided.



1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1867

def update_policy_rule_groups_with_http_info(policy_id, action, ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.update_policy_rule_groups ...'
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling Filevantage.update_policy_rule_groups"
  end
  # verify the required parameter 'action' is set
  if @api_client.config.client_side_validation && action.nil?
    fail ArgumentError, "Missing the required parameter 'action' when calling Filevantage.update_policy_rule_groups"
  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 Filevantage.update_policy_rule_groups"
  end
  # resource path
  local_var_path = '/filevantage/entities/policies-rule-groups/v1'

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

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

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

#update_rule_group_precedence(rule_group_id, ids, opts = {}) ⇒ RulegroupsResponse

Updates the rule precedence for all rules in the identified rule group. The ids for all rules contained within the rule group must be specified in the desired precedence order. Requests that do not represent all ids will not be processed.



1932
1933
1934
1935
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1932

def update_rule_group_precedence(rule_group_id, ids, opts = {})
  data, _status_code, _headers = update_rule_group_precedence_with_http_info(rule_group_id, ids, opts)
  data
end

#update_rule_group_precedence_with_http_info(rule_group_id, ids, opts = {}) ⇒ Array<(RulegroupsResponse, Integer, Hash)>

Updates the rule precedence for all rules in the identified rule group. The ids for &#x60;all&#x60; rules contained within the rule group must be specified in the desired precedence order. Requests that do not represent all ids will not be processed.



1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 1943

def update_rule_group_precedence_with_http_info(rule_group_id, ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.update_rule_group_precedence ...'
  end
  # verify the required parameter 'rule_group_id' is set
  if @api_client.config.client_side_validation && rule_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_group_id' when calling Filevantage.update_rule_group_precedence"
  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 Filevantage.update_rule_group_precedence"
  end
  # resource path
  local_var_path = '/filevantage/entities/rule-groups-rule-precedence/v1'

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

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

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

#update_rule_groups(body, opts = {}) ⇒ RulegroupsResponse

Updates the provided rule group. Provides the ability to update the name and description of the rule group.



2002
2003
2004
2005
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 2002

def update_rule_groups(body, opts = {})
  data, _status_code, _headers = update_rule_groups_with_http_info(body, opts)
  data
end

#update_rule_groups_with_http_info(body, opts = {}) ⇒ Array<(RulegroupsResponse, Integer, Hash)>

Updates the provided rule group. Provides the ability to update the name and description of the rule group.



2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 2012

def update_rule_groups_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.update_rule_groups ...'
  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 Filevantage.update_rule_groups"
  end
  # resource path
  local_var_path = '/filevantage/entities/rule-groups/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] || 'RulegroupsResponse'

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

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

#update_rules(body, opts = {}) ⇒ RulegroupsRulesResponse

Updates the provided rule configuration within the specified rule group. The rule must currently exist within the specified rule group.



2070
2071
2072
2073
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 2070

def update_rules(body, opts = {})
  data, _status_code, _headers = update_rules_with_http_info(body, opts)
  data
end

#update_rules_with_http_info(body, opts = {}) ⇒ Array<(RulegroupsRulesResponse, Integer, Hash)>

Updates the provided rule configuration within the specified rule group. The rule must currently exist within the specified rule group.



2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 2080

def update_rules_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.update_rules ...'
  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 Filevantage.update_rules"
  end
  # resource path
  local_var_path = '/filevantage/entities/rule-groups-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] || 'RulegroupsRulesResponse'

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

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

#update_scheduled_exclusions(body, opts = {}) ⇒ ScheduledexclusionsResponse

Updates the provided scheduled exclusion configuration within the provided policy. Updates the provided scheduled exclusion configuration within the provided policy.



2138
2139
2140
2141
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 2138

def update_scheduled_exclusions(body, opts = {})
  data, _status_code, _headers = update_scheduled_exclusions_with_http_info(body, opts)
  data
end

#update_scheduled_exclusions_with_http_info(body, opts = {}) ⇒ Array<(ScheduledexclusionsResponse, Integer, Hash)>

Updates the provided scheduled exclusion configuration within the provided policy. Updates the provided scheduled exclusion configuration within the provided policy.



2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
 
# File 'lib/crimson-falcon/api/filevantage.rb', line 2148

def update_scheduled_exclusions_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Filevantage.update_scheduled_exclusions ...'
  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 Filevantage.update_scheduled_exclusions"
  end
  # resource path
  local_var_path = '/filevantage/entities/policy-scheduled-exclusions/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] || 'ScheduledexclusionsResponse'

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

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