Class: Falcon::Ngsiem

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Ngsiem

Returns a new instance of Ngsiem.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#bulk_install_parsers(body, opts = {}) ⇒ ApiParserBulkInstallResponseV1

Installs multiple CrowdStrike-managed out-of-the-box (OOTB) parsers into the customer’s repository in a single operation. This endpoint provisions multiple pre-built parsers with their specific versions for the requesting customer ID (CID). The parsers are installed as-is and cannot be modified by the customer. Requires an array of parsers with parser_id and version in the request body. Maximum 100 parsers per request.

Parameters:

Returns:



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

def bulk_install_parsers(body, opts = {})
  data, _status_code, _headers = bulk_install_parsers_with_http_info(body, opts)
  data
end

#bulk_install_parsers_with_http_info(body, opts = {}) ⇒ Array<(ApiParserBulkInstallResponseV1, Integer, Hash)>

Installs multiple CrowdStrike-managed out-of-the-box (OOTB) parsers into the customer&#39;s repository in a single operation. This endpoint provisions multiple pre-built parsers with their specific versions for the requesting customer ID (CID). The parsers are installed as-is and cannot be modified by the customer. Requires an array of parsers with parser_id and version in the request body. Maximum 100 parsers per request.

Parameters:

Returns:



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

def bulk_install_parsers_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.bulk_install_parsers ...'
  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 Ngsiem.bulk_install_parsers"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/parsers/bulk-install/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] || 'ApiParserBulkInstallResponseV1'

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

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

#clone_parser(body, opts = {}) ⇒ ApiCloneParserResponseV1

Clone an existing parser with a new name

Parameters:

  • body (ApiCloneParserRequestV1) —

    clone parser request

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

    the optional parameters

Returns:



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

def clone_parser(body, opts = {})
  data, _status_code, _headers = clone_parser_with_http_info(body, opts)
  data
end

#clone_parser_with_http_info(body, opts = {}) ⇒ Array<(ApiCloneParserResponseV1, Integer, Hash)>

Clone an existing parser with a new name

Parameters:

  • body (ApiCloneParserRequestV1) —

    clone parser request

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

    the optional parameters

Returns:

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

    ApiCloneParserResponseV1 data, response status code and response headers



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 117

def clone_parser_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.clone_parser ...'
  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 Ngsiem.clone_parser"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/parsers-clone/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] || 'ApiCloneParserResponseV1'

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

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

#create_dashboard_from_template(opts = {}) ⇒ ApiCreateDashboardFromTemplateResponseV1

Create Dashboard from LogScale YAML Template in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_domain (String) —

    name of search domain (view or repo)

  • :name (String) —

    name of the dashboard

  • :yaml_template (File) —

    LogScale dashboard YAML template content, see schema at schemas.humio.com/

Returns:



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

def create_dashboard_from_template(opts = {})
  data, _status_code, _headers = create_dashboard_from_template_with_http_info(opts)
  data
end

#create_dashboard_from_template_with_http_info(opts = {}) ⇒ Array<(ApiCreateDashboardFromTemplateResponseV1, Integer, Hash)>

Create Dashboard from LogScale YAML Template in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_domain (String) —

    name of search domain (view or repo)

  • :name (String) —

    name of the dashboard

  • :yaml_template (File) —

    LogScale dashboard YAML template content, see schema at schemas.humio.com/

Returns:



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

def create_dashboard_from_template_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.create_dashboard_from_template ...'
  end
  allowable_values = ["all", "falcon", "third-party"]
  if @api_client.config.client_side_validation && opts[:'search_domain'] && !allowable_values.include?(opts[:'search_domain'])
    fail ArgumentError, "invalid value for \"search_domain\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/dashboards-template/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(['multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['search_domain'] = opts[:'search_domain'] if !opts[:'search_domain'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['yaml_template'] = opts[:'yaml_template'] if !opts[:'yaml_template'].nil?

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

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

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

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

#create_lookup_file(opts = {}) ⇒ ApiCreateLookupFileResponseV1

Create Lookup File in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_domain (String) —

    name of search domain (view or repo)

  • :filename (String) —

    Filename of the lookup file to create

  • :file (File) —

    file content to upload

Returns:



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

def create_lookup_file(opts = {})
  data, _status_code, _headers = create_lookup_file_with_http_info(opts)
  data
end

#create_lookup_file_with_http_info(opts = {}) ⇒ Array<(ApiCreateLookupFileResponseV1, Integer, Hash)>

Create Lookup File in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_domain (String) —

    name of search domain (view or repo)

  • :filename (String) —

    Filename of the lookup file to create

  • :file (File) —

    file content to upload

Returns:



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
310
311
312
313
314
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 260

def create_lookup_file_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.create_lookup_file ...'
  end
  allowable_values = ["all", "falcon", "third-party", "parsers-repository"]
  if @api_client.config.client_side_validation && opts[:'search_domain'] && !allowable_values.include?(opts[:'search_domain'])
    fail ArgumentError, "invalid value for \"search_domain\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/lookupfiles/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(['multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['search_domain'] = opts[:'search_domain'] if !opts[:'search_domain'].nil?
  form_params['filename'] = opts[:'filename'] if !opts[:'filename'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?

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

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

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

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

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

#create_parser(body, opts = {}) ⇒ ApiCreateParserResponseV1

Create Parser in NGSIEM. This endpoint has been deprecated in favour of the POST /entities/parsers-template/v1 API.

Parameters:

Returns:



320
321
322
323
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 320

def create_parser(body, opts = {})
  data, _status_code, _headers = create_parser_with_http_info(body, opts)
  data
end

#create_parser_from_template(opts = {}) ⇒ ApiCreateParserFromTemplateResponseV1

Create Parser from LogScale YAML Template in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :repository (String) —

    name of repository

  • :yaml_template (File) —

    LogScale Parser YAML template content, see schema at schemas.humio.com/

Returns:



387
388
389
390
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 387

def create_parser_from_template(opts = {})
  data, _status_code, _headers = create_parser_from_template_with_http_info(opts)
  data
end

#create_parser_from_template_with_http_info(opts = {}) ⇒ Array<(ApiCreateParserFromTemplateResponseV1, Integer, Hash)>

Create Parser from LogScale YAML Template in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :repository (String) —

    name of repository

  • :yaml_template (File) —

    LogScale Parser YAML template content, see schema at schemas.humio.com/

Returns:



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 397

def create_parser_from_template_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.create_parser_from_template ...'
  end
  allowable_values = ["parsers-repository"]
  if @api_client.config.client_side_validation && opts[:'repository'] && !allowable_values.include?(opts[:'repository'])
    fail ArgumentError, "invalid value for \"repository\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/parsers-template/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(['multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['repository'] = opts[:'repository'] if !opts[:'repository'].nil?
  form_params['yaml_template'] = opts[:'yaml_template'] if !opts[:'yaml_template'].nil?

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

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

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

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

#create_parser_with_http_info(body, opts = {}) ⇒ Array<(ApiCreateParserResponseV1, Integer, Hash)>

Create Parser in NGSIEM. This endpoint has been deprecated in favour of the POST /entities/parsers-template/v1 API.

Parameters:

Returns:

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

    ApiCreateParserResponseV1 data, response status code and response headers



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

def create_parser_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.create_parser ...'
  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 Ngsiem.create_parser"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/parsers/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] || 'ApiCreateParserResponseV1'

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

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

#create_saved_query(opts = {}) ⇒ ApiCreateSavedQueryResponseV1

Create Saved Query from LogScale YAML Template in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_domain (String) —

    name of search domain (view or repo)

  • :yaml_template (File) —

    LogScale Saved Query YAML template content, see schema at schemas.humio.com/

Returns:



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

def create_saved_query(opts = {})
  data, _status_code, _headers = create_saved_query_with_http_info(opts)
  data
end

#create_saved_query_with_http_info(opts = {}) ⇒ Array<(ApiCreateSavedQueryResponseV1, Integer, Hash)>

Create Saved Query from LogScale YAML Template in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_domain (String) —

    name of search domain (view or repo)

  • :yaml_template (File) —

    LogScale Saved Query YAML template content, see schema at schemas.humio.com/

Returns:



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 467

def create_saved_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.create_saved_query ...'
  end
  allowable_values = ["all", "falcon", "third-party"]
  if @api_client.config.client_side_validation && opts[:'search_domain'] && !allowable_values.include?(opts[:'search_domain'])
    fail ArgumentError, "invalid value for \"search_domain\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/savedqueries-template/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(['multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['search_domain'] = opts[:'search_domain'] if !opts[:'search_domain'].nil?
  form_params['yaml_template'] = opts[:'yaml_template'] if !opts[:'yaml_template'].nil?

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

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

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

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

#delete_dashboard(opts = {}) ⇒ ApiDeleteDashboardResponseV1

Delete Dashboard in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    dashboard ID value

  • :search_domain (String) —

    name of search domain (view or repo)

Returns:



527
528
529
530
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 527

def delete_dashboard(opts = {})
  data, _status_code, _headers = delete_dashboard_with_http_info(opts)
  data
end

#delete_dashboard_with_http_info(opts = {}) ⇒ Array<(ApiDeleteDashboardResponseV1, Integer, Hash)>

Delete Dashboard in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    dashboard ID value

  • :search_domain (String) —

    name of search domain (view or repo)

Returns:



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
580
581
582
583
584
585
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 537

def delete_dashboard_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.delete_dashboard ...'
  end
  allowable_values = ["all", "falcon", "third-party"]
  if @api_client.config.client_side_validation && opts[:'search_domain'] && !allowable_values.include?(opts[:'search_domain'])
    fail ArgumentError, "invalid value for \"search_domain\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/dashboards/v1'

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

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

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

#delete_lookup_file(opts = {}) ⇒ ApiDeleteLookupFileResponseV1

Delete Lookup File in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filename (String) —

    lookup file filename

  • :search_domain (String) —

    name of search domain (view or repo)

Returns:



592
593
594
595
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 592

def delete_lookup_file(opts = {})
  data, _status_code, _headers = delete_lookup_file_with_http_info(opts)
  data
end

#delete_lookup_file_with_http_info(opts = {}) ⇒ Array<(ApiDeleteLookupFileResponseV1, Integer, Hash)>

Delete Lookup File in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filename (String) —

    lookup file filename

  • :search_domain (String) —

    name of search domain (view or repo)

Returns:



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

def delete_lookup_file_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.delete_lookup_file ...'
  end
  allowable_values = ["all", "falcon", "third-party", "parsers-repository"]
  if @api_client.config.client_side_validation && opts[:'search_domain'] && !allowable_values.include?(opts[:'search_domain'])
    fail ArgumentError, "invalid value for \"search_domain\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/lookupfiles/v1'

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

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

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

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

#delete_parser(opts = {}) ⇒ ApiDeleteParserResponseV1

Delete Parser in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    parser ID value

  • :repository (String) —

    name of repository

Returns:



657
658
659
660
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 657

def delete_parser(opts = {})
  data, _status_code, _headers = delete_parser_with_http_info(opts)
  data
end

#delete_parser_with_http_info(opts = {}) ⇒ Array<(ApiDeleteParserResponseV1, Integer, Hash)>

Delete Parser in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    parser ID value

  • :repository (String) —

    name of repository

Returns:

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

    ApiDeleteParserResponseV1 data, response status code and response headers



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/ngsiem.rb', line 667

def delete_parser_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.delete_parser ...'
  end
  allowable_values = ["parsers-repository"]
  if @api_client.config.client_side_validation && opts[:'repository'] && !allowable_values.include?(opts[:'repository'])
    fail ArgumentError, "invalid value for \"repository\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/parsers/v1'

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

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

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

#delete_saved_query(opts = {}) ⇒ ApiDeleteSavedQueryResponseV1

Delete Saved Query in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    saved query ID value

  • :search_domain (String) —

    name of search domain (view or repo)

Returns:



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

def delete_saved_query(opts = {})
  data, _status_code, _headers = delete_saved_query_with_http_info(opts)
  data
end

#delete_saved_query_with_http_info(opts = {}) ⇒ Array<(ApiDeleteSavedQueryResponseV1, Integer, Hash)>

Delete Saved Query in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    saved query ID value

  • :search_domain (String) —

    name of search domain (view or repo)

Returns:



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

def delete_saved_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.delete_saved_query ...'
  end
  allowable_values = ["all", "falcon", "third-party"]
  if @api_client.config.client_side_validation && opts[:'search_domain'] && !allowable_values.include?(opts[:'search_domain'])
    fail ArgumentError, "invalid value for \"search_domain\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/savedqueries/v1'

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

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

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

#external_create_connector_config(body, opts = {}) ⇒ DataconnectionmanagementGenericCreateResponse

Create a new configuration for a data connector

Parameters:

Returns:



786
787
788
789
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 786

def external_create_connector_config(body, opts = {})
  data, _status_code, _headers = external_create_connector_config_with_http_info(body, opts)
  data
end

#external_create_connector_config_with_http_info(body, opts = {}) ⇒ Array<(DataconnectionmanagementGenericCreateResponse, Integer, Hash)>

Create a new configuration for a data connector

Parameters:

Returns:



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

def external_create_connector_config_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.external_create_connector_config ...'
  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 Ngsiem.external_create_connector_config"
  end
  # resource path
  local_var_path = '/ngsiem/entities/connectors/configs/v1'

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

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

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

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

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

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

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

#external_create_data_connection(body, opts = {}) ⇒ DataconnectionmanagementGenericResourcesResponse

Create a new data connection

Parameters:

Returns:



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

def external_create_data_connection(body, opts = {})
  data, _status_code, _headers = external_create_data_connection_with_http_info(body, opts)
  data
end

#external_create_data_connection_with_http_info(body, opts = {}) ⇒ Array<(DataconnectionmanagementGenericResourcesResponse, Integer, Hash)>

Create a new data connection

Parameters:

Returns:



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

def external_create_data_connection_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.external_create_data_connection ...'
  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 Ngsiem.external_create_data_connection"
  end
  # resource path
  local_var_path = '/ngsiem/entities/connections/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] || 'DataconnectionmanagementGenericResourcesResponse'

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

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

#external_delete_connector_configs(connector_id, ids, opts = {}) ⇒ MsaReplyAffectedEntities

Delete data connection config

Parameters:

  • connector_id (String) —

    Unique identifier of the connector

  • ids (Array<String>) —

    Unique identifiers of the config(s) to delete

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

    the optional parameters

Returns:



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

def external_delete_connector_configs(connector_id, ids, opts = {})
  data, _status_code, _headers = external_delete_connector_configs_with_http_info(connector_id, ids, opts)
  data
end

#external_delete_connector_configs_with_http_info(connector_id, ids, opts = {}) ⇒ Array<(MsaReplyAffectedEntities, Integer, Hash)>

Delete data connection config

Parameters:

  • connector_id (String) —

    Unique identifier of the connector

  • ids (Array<String>) —

    Unique identifiers of the config(s) to delete

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

    the optional parameters

Returns:

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

    MsaReplyAffectedEntities data, response status code and response headers



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
982
983
984
985
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 929

def external_delete_connector_configs_with_http_info(connector_id, ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.external_delete_connector_configs ...'
  end
  # verify the required parameter 'connector_id' is set
  if @api_client.config.client_side_validation && connector_id.nil?
    fail ArgumentError, "Missing the required parameter 'connector_id' when calling Ngsiem.external_delete_connector_configs"
  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 Ngsiem.external_delete_connector_configs"
  end
  if @api_client.config.client_side_validation && ids.length > 20
    fail ArgumentError, 'invalid value for "ids" when calling Ngsiem.external_delete_connector_configs, number of items must be less than or equal to 20.'
  end

  # resource path
  local_var_path = '/ngsiem/entities/connectors/configs/v1'

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

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

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

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

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

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

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

#external_delete_data_connection(ids, opts = {}) ⇒ MsaReplyAffectedEntities

Delete a data connection

Parameters:

  • ids (String) —

    Unique identifier of the data connection

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

    the optional parameters

Returns:



991
992
993
994
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 991

def external_delete_data_connection(ids, opts = {})
  data, _status_code, _headers = external_delete_data_connection_with_http_info(ids, opts)
  data
end

#external_delete_data_connection_with_http_info(ids, opts = {}) ⇒ Array<(MsaReplyAffectedEntities, Integer, Hash)>

Delete a data connection

Parameters:

  • ids (String) —

    Unique identifier of the data connection

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

    the optional parameters

Returns:

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

    MsaReplyAffectedEntities data, response status code and response headers



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

def external_delete_data_connection_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.external_delete_data_connection ...'
  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 Ngsiem.external_delete_data_connection"
  end
  # resource path
  local_var_path = '/ngsiem/entities/connections/v1'

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

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

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

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

#external_get_data_connection_by_id(ids, opts = {}) ⇒ DataconnectionmanagementDataConnectionResponse

Get data connection by ID

Parameters:

  • ids (Array<String>) —

    Unique identifier of the data connection

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

    the optional parameters

Returns:



1053
1054
1055
1056
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1053

def external_get_data_connection_by_id(ids, opts = {})
  data, _status_code, _headers = external_get_data_connection_by_id_with_http_info(ids, opts)
  data
end

#external_get_data_connection_by_id_with_http_info(ids, opts = {}) ⇒ Array<(DataconnectionmanagementDataConnectionResponse, Integer, Hash)>

Get data connection by ID

Parameters:

  • ids (Array<String>) —

    Unique identifier of the data connection

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

    the optional parameters

Returns:



1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1062

def external_get_data_connection_by_id_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.external_get_data_connection_by_id ...'
  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 Ngsiem.external_get_data_connection_by_id"
  end
  # resource path
  local_var_path = '/ngsiem/entities/connections/v1'

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

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

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

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

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

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

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

#external_get_data_connection_status(ids, opts = {}) ⇒ DataconnectionmanagementConnectionStatusResponse

Get data connection provisioning status

Parameters:

  • ids (Array<String>) —

    Unique identifier of the data connection

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

    the optional parameters

Returns:



1115
1116
1117
1118
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1115

def external_get_data_connection_status(ids, opts = {})
  data, _status_code, _headers = external_get_data_connection_status_with_http_info(ids, opts)
  data
end

#external_get_data_connection_status_with_http_info(ids, opts = {}) ⇒ Array<(DataconnectionmanagementConnectionStatusResponse, Integer, Hash)>

Get data connection provisioning status

Parameters:

  • ids (Array<String>) —

    Unique identifier of the data connection

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

    the optional parameters

Returns:



1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1124

def external_get_data_connection_status_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.external_get_data_connection_status ...'
  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 Ngsiem.external_get_data_connection_status"
  end
  # resource path
  local_var_path = '/ngsiem/entities/connections/status/v1'

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

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

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

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

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

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

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

#external_get_data_connection_token(ids, opts = {}) ⇒ DataconnectionmanagementConnectionTokenResponse

Get Ingest token for data connection

Parameters:

  • ids (String) —

    Unique identifier of the data connection

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

    the optional parameters

Returns:



1177
1178
1179
1180
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1177

def external_get_data_connection_token(ids, opts = {})
  data, _status_code, _headers = external_get_data_connection_token_with_http_info(ids, opts)
  data
end

#external_get_data_connection_token_with_http_info(ids, opts = {}) ⇒ Array<(DataconnectionmanagementConnectionTokenResponse, Integer, Hash)>

Get Ingest token for data connection

Parameters:

  • ids (String) —

    Unique identifier of the data connection

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

    the optional parameters

Returns:



1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1186

def external_get_data_connection_token_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.external_get_data_connection_token ...'
  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 Ngsiem.external_get_data_connection_token"
  end
  # resource path
  local_var_path = '/ngsiem/entities/connections/token/v1'

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

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

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

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

#external_list_connector_configs(ids, opts = {}) ⇒ DataconnectionmanagementConfigResponse

List configurations for a data connector

Parameters:

  • ids (String) —

    Unique identifier of the data connector

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

    the optional parameters

Returns:



1239
1240
1241
1242
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1239

def external_list_connector_configs(ids, opts = {})
  data, _status_code, _headers = external_list_connector_configs_with_http_info(ids, opts)
  data
end

#external_list_connector_configs_with_http_info(ids, opts = {}) ⇒ Array<(DataconnectionmanagementConfigResponse, Integer, Hash)>

List configurations for a data connector

Parameters:

  • ids (String) —

    Unique identifier of the data connector

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

    the optional parameters

Returns:



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
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1248

def external_list_connector_configs_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.external_list_connector_configs ...'
  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 Ngsiem.external_list_connector_configs"
  end
  # resource path
  local_var_path = '/ngsiem/entities/connectors/configs/v1'

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

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

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

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

#external_list_data_connections(opts = {}) ⇒ DataconnectionmanagementDataConnectionResponse

List and search data connections

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Optional filter criteria in FQL format

  • :offset (Integer) —

    Starting position for pagination

  • :limit (Integer) —

    Maximum number of items to return

  • :sort (String) —

    Sort field and direction

Returns:



1304
1305
1306
1307
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1304

def external_list_data_connections(opts = {})
  data, _status_code, _headers = external_list_data_connections_with_http_info(opts)
  data
end

#external_list_data_connections_with_http_info(opts = {}) ⇒ Array<(DataconnectionmanagementDataConnectionResponse, Integer, Hash)>

List and search data connections

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Optional filter criteria in FQL format

  • :offset (Integer) —

    Starting position for pagination

  • :limit (Integer) —

    Maximum number of items to return

  • :sort (String) —

    Sort field and direction

Returns:



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
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1316

def external_list_data_connections_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.external_list_data_connections ...'
  end
  # resource path
  local_var_path = '/ngsiem/combined/connections/v1'

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

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

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

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

#external_list_data_connectors(opts = {}) ⇒ DataconnectionmanagementDataConnectorResponse

List available data connectors

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Optional filter criteria in FQL format

  • :offset (Integer) —

    Starting position for pagination

  • :limit (Integer) —

    Maximum number of items to return

  • :sort (String) —

    Sort field and direction

Returns:



1371
1372
1373
1374
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1371

def external_list_data_connectors(opts = {})
  data, _status_code, _headers = external_list_data_connectors_with_http_info(opts)
  data
end

#external_list_data_connectors_with_http_info(opts = {}) ⇒ Array<(DataconnectionmanagementDataConnectorResponse, Integer, Hash)>

List available data connectors

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Optional filter criteria in FQL format

  • :offset (Integer) —

    Starting position for pagination

  • :limit (Integer) —

    Maximum number of items to return

  • :sort (String) —

    Sort field and direction

Returns:



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/ngsiem.rb', line 1383

def external_list_data_connectors_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.external_list_data_connectors ...'
  end
  # resource path
  local_var_path = '/ngsiem/combined/connectors/v1'

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

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

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

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

#external_patch_connector_config(ids, body, opts = {}) ⇒ MsaReplyAffectedEntities

Patch configurations for a data connector

Parameters:

Returns:



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

def external_patch_connector_config(ids, body, opts = {})
  data, _status_code, _headers = external_patch_connector_config_with_http_info(ids, body, opts)
  data
end

#external_patch_connector_config_with_http_info(ids, body, opts = {}) ⇒ Array<(MsaReplyAffectedEntities, Integer, Hash)>

Patch configurations for a data connector

Parameters:

Returns:

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

    MsaReplyAffectedEntities data, response status code and response headers



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
1494
1495
1496
1497
1498
1499
1500
1501
1502
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1446

def external_patch_connector_config_with_http_info(ids, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.external_patch_connector_config ...'
  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 Ngsiem.external_patch_connector_config"
  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 Ngsiem.external_patch_connector_config"
  end
  # resource path
  local_var_path = '/ngsiem/entities/connectors/configs/v1'

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

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

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

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

#external_regenerate_data_connection_token(ids, opts = {}) ⇒ DataconnectionmanagementConnectionTokenResponse

Regenerate Ingest token for data connection

Parameters:

  • ids (String) —

    Unique identifier of the data connection

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

    the optional parameters

Returns:



1508
1509
1510
1511
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1508

def external_regenerate_data_connection_token(ids, opts = {})
  data, _status_code, _headers = external_regenerate_data_connection_token_with_http_info(ids, opts)
  data
end

#external_regenerate_data_connection_token_with_http_info(ids, opts = {}) ⇒ Array<(DataconnectionmanagementConnectionTokenResponse, Integer, Hash)>

Regenerate Ingest token for data connection

Parameters:

  • ids (String) —

    Unique identifier of the data connection

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

    the optional parameters

Returns:



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
1562
1563
1564
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1517

def external_regenerate_data_connection_token_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.external_regenerate_data_connection_token ...'
  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 Ngsiem.external_regenerate_data_connection_token"
  end
  # resource path
  local_var_path = '/ngsiem/entities/connections/token/v1'

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

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

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

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

#external_update_data_connection(ids, body, opts = {}) ⇒ MsaReplyAffectedEntities

Update a data connection

Parameters:

Returns:



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

def external_update_data_connection(ids, body, opts = {})
  data, _status_code, _headers = external_update_data_connection_with_http_info(ids, body, opts)
  data
end

#external_update_data_connection_status(ids, body, opts = {}) ⇒ DataconnectionmanagementConnectionStatusResponse

Update data connection status

Parameters:

Returns:



1644
1645
1646
1647
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1644

def external_update_data_connection_status(ids, body, opts = {})
  data, _status_code, _headers = external_update_data_connection_status_with_http_info(ids, body, opts)
  data
end

#external_update_data_connection_status_with_http_info(ids, body, opts = {}) ⇒ Array<(DataconnectionmanagementConnectionStatusResponse, Integer, Hash)>

Update data connection status

Parameters:

Returns:



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
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1654

def external_update_data_connection_status_with_http_info(ids, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.external_update_data_connection_status ...'
  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 Ngsiem.external_update_data_connection_status"
  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 Ngsiem.external_update_data_connection_status"
  end
  # resource path
  local_var_path = '/ngsiem/entities/connections/status/v1'

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

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

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

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

#external_update_data_connection_with_http_info(ids, body, opts = {}) ⇒ Array<(MsaReplyAffectedEntities, Integer, Hash)>

Update a data connection

Parameters:

Returns:

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

    MsaReplyAffectedEntities data, response status code and response headers



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
1630
1631
1632
1633
1634
1635
1636
1637
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1581

def external_update_data_connection_with_http_info(ids, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.external_update_data_connection ...'
  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 Ngsiem.external_update_data_connection"
  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 Ngsiem.external_update_data_connection"
  end
  # resource path
  local_var_path = '/ngsiem/entities/connections/v1'

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

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

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

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

#get_dashboard_template(opts = {}) ⇒ ApiGetDashboardTemplateResponseV1

Retrieve Dashboard in NGSIEM as LogScale YAML Template

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    dashboard ID value

  • :search_domain (String) —

    name of search domain (view or repo)

Returns:



1717
1718
1719
1720
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1717

def get_dashboard_template(opts = {})
  data, _status_code, _headers = get_dashboard_template_with_http_info(opts)
  data
end

#get_dashboard_template_with_http_info(opts = {}) ⇒ Array<(ApiGetDashboardTemplateResponseV1, Integer, Hash)>

Retrieve Dashboard in NGSIEM as LogScale YAML Template

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    dashboard ID value

  • :search_domain (String) —

    name of search domain (view or repo)

Returns:



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/ngsiem.rb', line 1727

def get_dashboard_template_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.get_dashboard_template ...'
  end
  allowable_values = ["all", "falcon", "third-party", "dashboards"]
  if @api_client.config.client_side_validation && opts[:'search_domain'] && !allowable_values.include?(opts[:'search_domain'])
    fail ArgumentError, "invalid value for \"search_domain\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/dashboards-template/v1'

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

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

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

#get_lookup_file(opts = {}) ⇒ nil

Retrieve Lookup File in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filename (String) —

    lookup file filename

  • :search_domain (String) —

    name of search domain (view or repo)

Returns:

  • (nil) 


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

def get_lookup_file(opts = {})
  get_lookup_file_with_http_info(opts)
  nil
end

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

Retrieve Lookup File in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filename (String) —

    lookup file filename

  • :search_domain (String) —

    name of search domain (view or repo)

Returns:

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

    nil, response status code and response headers



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

def get_lookup_file_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.get_lookup_file ...'
  end
  allowable_values = ["all", "falcon", "third-party", "dashboards", "parsers-repository"]
  if @api_client.config.client_side_validation && opts[:'search_domain'] && !allowable_values.include?(opts[:'search_domain'])
    fail ArgumentError, "invalid value for \"search_domain\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/lookupfiles/v1'

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

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

#get_lookup_from_package_v1(repository, package, filename, opts = {}) ⇒ nil

Download lookup file in package from NGSIEM

Parameters:

  • repository (String) —

    name of repository

  • package (String) —

    name of package

  • filename (String) —

    name of lookup file

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

    the optional parameters

Returns:

  • (nil) 


1848
1849
1850
1851
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1848

def get_lookup_from_package_v1(repository, package, filename, opts = {})
  get_lookup_from_package_v1_with_http_info(repository, package, filename, opts)
  nil
end

#get_lookup_from_package_v1_with_http_info(repository, package, filename, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Download lookup file in package from NGSIEM

Parameters:

  • repository (String) —

    name of repository

  • package (String) —

    name of package

  • filename (String) —

    name of lookup file

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1859

def get_lookup_from_package_v1_with_http_info(repository, package, filename, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.get_lookup_from_package_v1 ...'
  end
  # verify the required parameter 'repository' is set
  if @api_client.config.client_side_validation && repository.nil?
    fail ArgumentError, "Missing the required parameter 'repository' when calling Ngsiem.get_lookup_from_package_v1"
  end
  # verify the required parameter 'package' is set
  if @api_client.config.client_side_validation && package.nil?
    fail ArgumentError, "Missing the required parameter 'package' when calling Ngsiem.get_lookup_from_package_v1"
  end
  # verify the required parameter 'filename' is set
  if @api_client.config.client_side_validation && filename.nil?
    fail ArgumentError, "Missing the required parameter 'filename' when calling Ngsiem.get_lookup_from_package_v1"
  end
  # resource path
  local_var_path = '/humio/api/v1/repositories/{repository}/files/{package}/{filename}'.sub('{' + 'repository' + '}', CGI.escape(repository.to_s)).sub('{' + 'package' + '}', CGI.escape(package.to_s)).sub('{' + 'filename' + '}', CGI.escape(filename.to_s))

  # 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/octet-stream', 'application/json'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

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

#get_lookup_from_package_with_namespace_v1(repository, namespace, package, filename, opts = {}) ⇒ nil

Download lookup file in namespaced package from NGSIEM

Parameters:

  • repository (String) —

    name of repository

  • namespace (String) —

    name of namespace

  • package (String) —

    name of package

  • filename (String) —

    name of lookup file

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

    the optional parameters

Returns:

  • (nil) 


1922
1923
1924
1925
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1922

def get_lookup_from_package_with_namespace_v1(repository, namespace, package, filename, opts = {})
  get_lookup_from_package_with_namespace_v1_with_http_info(repository, namespace, package, filename, opts)
  nil
end

#get_lookup_from_package_with_namespace_v1_with_http_info(repository, namespace, package, filename, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Download lookup file in namespaced package from NGSIEM

Parameters:

  • repository (String) —

    name of repository

  • namespace (String) —

    name of namespace

  • package (String) —

    name of package

  • filename (String) —

    name of lookup file

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1934
1935
1936
1937
1938
1939
1940
1941
1942
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
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1934

def get_lookup_from_package_with_namespace_v1_with_http_info(repository, namespace, package, filename, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.get_lookup_from_package_with_namespace_v1 ...'
  end
  # verify the required parameter 'repository' is set
  if @api_client.config.client_side_validation && repository.nil?
    fail ArgumentError, "Missing the required parameter 'repository' when calling Ngsiem.get_lookup_from_package_with_namespace_v1"
  end
  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    fail ArgumentError, "Missing the required parameter 'namespace' when calling Ngsiem.get_lookup_from_package_with_namespace_v1"
  end
  # verify the required parameter 'package' is set
  if @api_client.config.client_side_validation && package.nil?
    fail ArgumentError, "Missing the required parameter 'package' when calling Ngsiem.get_lookup_from_package_with_namespace_v1"
  end
  # verify the required parameter 'filename' is set
  if @api_client.config.client_side_validation && filename.nil?
    fail ArgumentError, "Missing the required parameter 'filename' when calling Ngsiem.get_lookup_from_package_with_namespace_v1"
  end
  # resource path
  local_var_path = '/humio/api/v1/repositories/{repository}/files/{namespace}/{package}/{filename}'.sub('{' + 'repository' + '}', CGI.escape(repository.to_s)).sub('{' + 'namespace' + '}', CGI.escape(namespace.to_s)).sub('{' + 'package' + '}', CGI.escape(package.to_s)).sub('{' + 'filename' + '}', CGI.escape(filename.to_s))

  # 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/octet-stream', 'application/json'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

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

#get_lookup_v1(repository, filename, opts = {}) ⇒ nil

Download lookup file from NGSIEM

Parameters:

  • repository (String) —

    name of repository

  • filename (String) —

    name of lookup file

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

    the optional parameters

Returns:

  • (nil) 


1999
2000
2001
2002
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 1999

def get_lookup_v1(repository, filename, opts = {})
  get_lookup_v1_with_http_info(repository, filename, opts)
  nil
end

#get_lookup_v1_with_http_info(repository, filename, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Download lookup file from NGSIEM

Parameters:

  • repository (String) —

    name of repository

  • filename (String) —

    name of lookup file

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2009
2010
2011
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
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2009

def get_lookup_v1_with_http_info(repository, filename, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.get_lookup_v1 ...'
  end
  # verify the required parameter 'repository' is set
  if @api_client.config.client_side_validation && repository.nil?
    fail ArgumentError, "Missing the required parameter 'repository' when calling Ngsiem.get_lookup_v1"
  end
  # verify the required parameter 'filename' is set
  if @api_client.config.client_side_validation && filename.nil?
    fail ArgumentError, "Missing the required parameter 'filename' when calling Ngsiem.get_lookup_v1"
  end
  # resource path
  local_var_path = '/humio/api/v1/repositories/{repository}/files/{filename}'.sub('{' + 'repository' + '}', CGI.escape(repository.to_s)).sub('{' + 'filename' + '}', CGI.escape(filename.to_s))

  # 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/octet-stream', 'application/json'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

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

#get_parser(opts = {}) ⇒ ApiGetParserResponseV1

Retrieve Parser in NGSIEM. This endpoint has been deprecated in favour of the GET /entities/parsers-template/v1 API.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    parser ID value

  • :repository (String) —

    name of repository

Returns:



2066
2067
2068
2069
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2066

def get_parser(opts = {})
  data, _status_code, _headers = get_parser_with_http_info(opts)
  data
end

#get_parser_template(opts = {}) ⇒ ApiGetParserTemplateResponseV1

Retrieve Parser in NGSIEM as LogScale YAML Template

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    parser ID value

  • :repository (String) —

    name of repository

Returns:



2131
2132
2133
2134
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2131

def get_parser_template(opts = {})
  data, _status_code, _headers = get_parser_template_with_http_info(opts)
  data
end

#get_parser_template_with_http_info(opts = {}) ⇒ Array<(ApiGetParserTemplateResponseV1, Integer, Hash)>

Retrieve Parser in NGSIEM as LogScale YAML Template

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    parser ID value

  • :repository (String) —

    name of repository

Returns:



2141
2142
2143
2144
2145
2146
2147
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
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2141

def get_parser_template_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.get_parser_template ...'
  end
  allowable_values = ["parsers-repository"]
  if @api_client.config.client_side_validation && opts[:'repository'] && !allowable_values.include?(opts[:'repository'])
    fail ArgumentError, "invalid value for \"repository\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/parsers-template/v1'

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

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

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

#get_parser_with_http_info(opts = {}) ⇒ Array<(ApiGetParserResponseV1, Integer, Hash)>

Retrieve Parser in NGSIEM. This endpoint has been deprecated in favour of the GET /entities/parsers-template/v1 API.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    parser ID value

  • :repository (String) —

    name of repository

Returns:

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

    ApiGetParserResponseV1 data, response status code and response headers



2076
2077
2078
2079
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
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2076

def get_parser_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.get_parser ...'
  end
  allowable_values = ["parsers-repository"]
  if @api_client.config.client_side_validation && opts[:'repository'] && !allowable_values.include?(opts[:'repository'])
    fail ArgumentError, "invalid value for \"repository\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/parsers/v1'

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

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

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

#get_saved_query_template(opts = {}) ⇒ ApiGetSavedQueryResponseV1

Retrieve Saved Query in NGSIEM as LogScale YAML Template

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    saved query ID value

  • :search_domain (String) —

    name of search domain (view or repo)

Returns:



2196
2197
2198
2199
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2196

def get_saved_query_template(opts = {})
  data, _status_code, _headers = get_saved_query_template_with_http_info(opts)
  data
end

#get_saved_query_template_with_http_info(opts = {}) ⇒ Array<(ApiGetSavedQueryResponseV1, Integer, Hash)>

Retrieve Saved Query in NGSIEM as LogScale YAML Template

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    saved query ID value

  • :search_domain (String) —

    name of search domain (view or repo)

Returns:

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

    ApiGetSavedQueryResponseV1 data, response status code and response headers



2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2206

def get_saved_query_template_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.get_saved_query_template ...'
  end
  allowable_values = ["all", "falcon", "third-party", "dashboards"]
  if @api_client.config.client_side_validation && opts[:'search_domain'] && !allowable_values.include?(opts[:'search_domain'])
    fail ArgumentError, "invalid value for \"search_domain\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/savedqueries-template/v1'

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

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

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

#get_search_status_v1(repository, id, opts = {}) ⇒ ApiQueryJobsResults

Get status of search

Parameters:

  • repository (String) —

    name of repository

  • id (String) —

    id of query

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

    the optional parameters

Returns:



2261
2262
2263
2264
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2261

def get_search_status_v1(repository, id, opts = {})
  data, _status_code, _headers = get_search_status_v1_with_http_info(repository, id, opts)
  data
end

#get_search_status_v1_with_http_info(repository, id, opts = {}) ⇒ Array<(ApiQueryJobsResults, Integer, Hash)>

Get status of search

Parameters:

  • repository (String) —

    name of repository

  • id (String) —

    id of query

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

    the optional parameters

Returns:

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

    ApiQueryJobsResults data, response status code and response headers



2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2271

def get_search_status_v1_with_http_info(repository, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.get_search_status_v1 ...'
  end
  # verify the required parameter 'repository' is set
  if @api_client.config.client_side_validation && repository.nil?
    fail ArgumentError, "Missing the required parameter 'repository' when calling Ngsiem.get_search_status_v1"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling Ngsiem.get_search_status_v1"
  end
  # resource path
  local_var_path = '/humio/api/v1/repositories/{repository}/queryjobs/{id}'.sub('{' + 'repository' + '}', CGI.escape(repository.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # 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', 'text/plain', 'text/html', 'application/x-ndjson'])

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

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

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

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

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

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

#install_parser(body, opts = {}) ⇒ ApiParserInstallResponseV1

Installs a CrowdStrike-managed out-of-the-box (OOTB) parser into the customer’s repository. This endpoint provisions a pre-built parser with a specific version for the requesting customer ID (CID). The parser is installed as-is and cannot be modified by the customer. Requires parser_id and version in the request body.

Parameters:

  • body (ApiParserInstallRequestV1) —

    create parser install request

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

    the optional parameters

Returns:



2327
2328
2329
2330
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2327

def install_parser(body, opts = {})
  data, _status_code, _headers = install_parser_with_http_info(body, opts)
  data
end

#install_parser_with_http_info(body, opts = {}) ⇒ Array<(ApiParserInstallResponseV1, Integer, Hash)>

Installs a CrowdStrike-managed out-of-the-box (OOTB) parser into the customer&#39;s repository. This endpoint provisions a pre-built parser with a specific version for the requesting customer ID (CID). The parser is installed as-is and cannot be modified by the customer. Requires parser_id and version in the request body.

Parameters:

  • body (ApiParserInstallRequestV1) —

    create parser install request

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

    the optional parameters

Returns:

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

    ApiParserInstallResponseV1 data, response status code and response headers



2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2336

def install_parser_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.install_parser ...'
  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 Ngsiem.install_parser"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/parsers/install/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] || 'ApiParserInstallResponseV1'

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

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

#list_dashboards(opts = {}) ⇒ ApiListDashboardsResponseV1

List Dashboards in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    maximum number of results to return (default to ‘50’)

  • :offset (String) —

    number of results to offset the returned results by (default to ‘0’)

  • :filter (String) —

    FQL filter to apply to the name of the content, only currently support text match on name field: name:~&#39;value&#39;

  • :search_domain (String) —

    name of search domain (view or repo)

Returns:



2396
2397
2398
2399
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2396

def list_dashboards(opts = {})
  data, _status_code, _headers = list_dashboards_with_http_info(opts)
  data
end

#list_dashboards_with_http_info(opts = {}) ⇒ Array<(ApiListDashboardsResponseV1, Integer, Hash)>

List Dashboards in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    maximum number of results to return (default to ‘50’)

  • :offset (String) —

    number of results to offset the returned results by (default to ‘0’)

  • :filter (String) —

    FQL filter to apply to the name of the content, only currently support text match on name field: name:~&#39;value&#39;

  • :search_domain (String) —

    name of search domain (view or repo)

Returns:

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

    ApiListDashboardsResponseV1 data, response status code and response headers



2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2408

def list_dashboards_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.list_dashboards ...'
  end
  pattern = Regexp.new(/^\d{1,4}$/)
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"limit\"]' when calling Ngsiem.list_dashboards, must conform to the pattern #{pattern}."
  end

  pattern = Regexp.new(/^\d{1,4}$/)
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"offset\"]' when calling Ngsiem.list_dashboards, must conform to the pattern #{pattern}."
  end

  allowable_values = ["all", "falcon", "third-party", "dashboards"]
  if @api_client.config.client_side_validation && opts[:'search_domain'] && !allowable_values.include?(opts[:'search_domain'])
    fail ArgumentError, "invalid value for \"search_domain\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/queries/dashboards/v1'

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

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

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

#list_lookup_files(opts = {}) ⇒ ApiListLookupFilesResponseV1

List Lookup Files in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    maximum number of results to return (default to ‘50’)

  • :offset (String) —

    number of results to offset the returned results by (default to ‘0’)

  • :filter (String) —

    FQL filter to apply to the name of the content, only currently support text match on name field: name:~&#39;value&#39;

  • :search_domain (String) —

    name of search domain (view or repo)

Returns:



2477
2478
2479
2480
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2477

def list_lookup_files(opts = {})
  data, _status_code, _headers = list_lookup_files_with_http_info(opts)
  data
end

#list_lookup_files_with_http_info(opts = {}) ⇒ Array<(ApiListLookupFilesResponseV1, Integer, Hash)>

List Lookup Files in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    maximum number of results to return (default to ‘50’)

  • :offset (String) —

    number of results to offset the returned results by (default to ‘0’)

  • :filter (String) —

    FQL filter to apply to the name of the content, only currently support text match on name field: name:~&#39;value&#39;

  • :search_domain (String) —

    name of search domain (view or repo)

Returns:



2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2489

def list_lookup_files_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.list_lookup_files ...'
  end
  pattern = Regexp.new(/^\d{1,4}$/)
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"limit\"]' when calling Ngsiem.list_lookup_files, must conform to the pattern #{pattern}."
  end

  pattern = Regexp.new(/^\d{1,4}$/)
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"offset\"]' when calling Ngsiem.list_lookup_files, must conform to the pattern #{pattern}."
  end

  allowable_values = ["all", "falcon", "third-party", "dashboards", "parsers-repository"]
  if @api_client.config.client_side_validation && opts[:'search_domain'] && !allowable_values.include?(opts[:'search_domain'])
    fail ArgumentError, "invalid value for \"search_domain\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/queries/lookupfiles/v1'

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

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

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

#list_parsers(opts = {}) ⇒ ApiListParsersResponseV1

List Parsers in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    maximum number of results to return (default to ‘50’)

  • :offset (String) —

    number of results to offset the returned results by (default to ‘0’)

  • :filter (String) —

    FQL filter to apply to the name of the content, only currently support text match on name field: name:~&#39;value&#39;

  • :repository (String) —

    name of repository

  • :update_available (String) —

    filter parsers by update availability

  • :parser_type (String) —

    filter parsers by type

Returns:



2560
2561
2562
2563
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2560

def list_parsers(opts = {})
  data, _status_code, _headers = list_parsers_with_http_info(opts)
  data
end

#list_parsers_with_http_info(opts = {}) ⇒ Array<(ApiListParsersResponseV1, Integer, Hash)>

List Parsers in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    maximum number of results to return (default to ‘50’)

  • :offset (String) —

    number of results to offset the returned results by (default to ‘0’)

  • :filter (String) —

    FQL filter to apply to the name of the content, only currently support text match on name field: name:~&#39;value&#39;

  • :repository (String) —

    name of repository

  • :update_available (String) —

    filter parsers by update availability

  • :parser_type (String) —

    filter parsers by type

Returns:

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

    ApiListParsersResponseV1 data, response status code and response headers



2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2574

def list_parsers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.list_parsers ...'
  end
  pattern = Regexp.new(/^\d{1,4}$/)
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"limit\"]' when calling Ngsiem.list_parsers, must conform to the pattern #{pattern}."
  end

  pattern = Regexp.new(/^\d{1,4}$/)
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"offset\"]' when calling Ngsiem.list_parsers, must conform to the pattern #{pattern}."
  end

  allowable_values = ["parsers-repository"]
  if @api_client.config.client_side_validation && opts[:'repository'] && !allowable_values.include?(opts[:'repository'])
    fail ArgumentError, "invalid value for \"repository\", must be one of #{allowable_values}"
  end
  allowable_values = ["true", "false"]
  if @api_client.config.client_side_validation && opts[:'update_available'] && !allowable_values.include?(opts[:'update_available'])
    fail ArgumentError, "invalid value for \"update_available\", must be one of #{allowable_values}"
  end
  allowable_values = ["ootb", "custom"]
  if @api_client.config.client_side_validation && opts[:'parser_type'] && !allowable_values.include?(opts[:'parser_type'])
    fail ArgumentError, "invalid value for \"parser_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/queries/parsers/v1'

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

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

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

#list_saved_queries(opts = {}) ⇒ ApiListSavedQueriesResponseV1

Get Saved Queries in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    maximum number of results to return (default to ‘50’)

  • :offset (String) —

    number of results to offset the returned results by (default to ‘0’)

  • :filter (String) —

    FQL filter to apply to the name of the content, only currently support text match on name field: name:~&#39;value&#39;

  • :search_domain (String) —

    name of search domain (view or repo)

Returns:



2653
2654
2655
2656
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2653

def list_saved_queries(opts = {})
  data, _status_code, _headers = list_saved_queries_with_http_info(opts)
  data
end

#list_saved_queries_with_http_info(opts = {}) ⇒ Array<(ApiListSavedQueriesResponseV1, Integer, Hash)>

Get Saved Queries in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (String) —

    maximum number of results to return (default to ‘50’)

  • :offset (String) —

    number of results to offset the returned results by (default to ‘0’)

  • :filter (String) —

    FQL filter to apply to the name of the content, only currently support text match on name field: name:~&#39;value&#39;

  • :search_domain (String) —

    name of search domain (view or repo)

Returns:



2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2665

def list_saved_queries_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.list_saved_queries ...'
  end
  pattern = Regexp.new(/^\d{1,4}$/)
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"limit\"]' when calling Ngsiem.list_saved_queries, must conform to the pattern #{pattern}."
  end

  pattern = Regexp.new(/^\d{1,4}$/)
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"offset\"]' when calling Ngsiem.list_saved_queries, must conform to the pattern #{pattern}."
  end

  allowable_values = ["all", "falcon", "third-party", "dashboards"]
  if @api_client.config.client_side_validation && opts[:'search_domain'] && !allowable_values.include?(opts[:'search_domain'])
    fail ArgumentError, "invalid value for \"search_domain\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/queries/savedqueries/v1'

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

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

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

#start_search_v1(repository, body, opts = {}) ⇒ ApiQueryJobResponse

Initiate search

Parameters:

  • repository (String) —

    name of repository

  • body (ApiQueryJobInput) —

    Query Job JSON request body

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

    the optional parameters

Returns:



2732
2733
2734
2735
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2732

def start_search_v1(repository, body, opts = {})
  data, _status_code, _headers = start_search_v1_with_http_info(repository, body, opts)
  data
end

#start_search_v1_with_http_info(repository, body, opts = {}) ⇒ Array<(ApiQueryJobResponse, Integer, Hash)>

Initiate search

Parameters:

  • repository (String) —

    name of repository

  • body (ApiQueryJobInput) —

    Query Job JSON request body

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

    the optional parameters

Returns:

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

    ApiQueryJobResponse data, response status code and response headers



2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2742

def start_search_v1_with_http_info(repository, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.start_search_v1 ...'
  end
  # verify the required parameter 'repository' is set
  if @api_client.config.client_side_validation && repository.nil?
    fail ArgumentError, "Missing the required parameter 'repository' when calling Ngsiem.start_search_v1"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling Ngsiem.start_search_v1"
  end
  # resource path
  local_var_path = '/humio/api/v1/repositories/{repository}/queryjobs'.sub('{' + 'repository' + '}', CGI.escape(repository.to_s))

  # 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', 'text/plain', 'text/html'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
  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] || 'ApiQueryJobResponse'

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

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

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

#stop_search_v1(repository, id, opts = {}) ⇒ nil

Stop search

Parameters:

  • repository (String) —

    name of repository

  • id (String) —

    id of query

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

    the optional parameters

Returns:

  • (nil) 


2804
2805
2806
2807
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2804

def stop_search_v1(repository, id, opts = {})
  stop_search_v1_with_http_info(repository, id, opts)
  nil
end

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

Stop search

Parameters:

  • repository (String) —

    name of repository

  • id (String) —

    id of query

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2814

def stop_search_v1_with_http_info(repository, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.stop_search_v1 ...'
  end
  # verify the required parameter 'repository' is set
  if @api_client.config.client_side_validation && repository.nil?
    fail ArgumentError, "Missing the required parameter 'repository' when calling Ngsiem.stop_search_v1"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling Ngsiem.stop_search_v1"
  end
  # resource path
  local_var_path = '/humio/api/v1/repositories/{repository}/queryjobs/{id}'.sub('{' + 'repository' + '}', CGI.escape(repository.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

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

#test_parser_from_template(opts = {}) ⇒ ApiTestParserFromTemplateResponseV1

Test Parser from LogScale YAML Template in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :yaml_template (File) —

    LogScale Parser YAML template content, see schema at schemas.humio.com/

  • :schema_validation_enabled (Boolean) —

    When true, schema validation is enforced (CPS) and validates against Crowdstrike Parsing Standard

Returns:



2871
2872
2873
2874
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2871

def test_parser_from_template(opts = {})
  data, _status_code, _headers = test_parser_from_template_with_http_info(opts)
  data
end

#test_parser_from_template_with_http_info(opts = {}) ⇒ Array<(ApiTestParserFromTemplateResponseV1, Integer, Hash)>

Test Parser from LogScale YAML Template in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :yaml_template (File) —

    LogScale Parser YAML template content, see schema at schemas.humio.com/

  • :schema_validation_enabled (Boolean) —

    When true, schema validation is enforced (CPS) and validates against Crowdstrike Parsing Standard

Returns:



2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2881

def test_parser_from_template_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.test_parser_from_template ...'
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/parsers-template-test/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(['multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['yaml_template'] = opts[:'yaml_template'] if !opts[:'yaml_template'].nil?
  form_params['schema_validation_enabled'] = opts[:'schema_validation_enabled'] if !opts[:'schema_validation_enabled'].nil?

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

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

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

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

#update_dashboard_from_template(opts = {}) ⇒ ApiUpdateDashboardFromTemplateResponseV1

Update Dashboard from LogScale YAML Template in NGSIEM.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_domain (String) —

    name of search domain (view or repo)

  • :ids (String) —

    id of the dashboard

  • :yaml_template (File) —

    LogScale dashboard YAML template content, see schema at schemas.humio.com/

Returns:



2938
2939
2940
2941
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2938

def update_dashboard_from_template(opts = {})
  data, _status_code, _headers = update_dashboard_from_template_with_http_info(opts)
  data
end

#update_dashboard_from_template_with_http_info(opts = {}) ⇒ Array<(ApiUpdateDashboardFromTemplateResponseV1, Integer, Hash)>

Update Dashboard from LogScale YAML Template in NGSIEM.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_domain (String) —

    name of search domain (view or repo)

  • :ids (String) —

    id of the dashboard

  • :yaml_template (File) —

    LogScale dashboard YAML template content, see schema at schemas.humio.com/

Returns:



2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 2949

def update_dashboard_from_template_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.update_dashboard_from_template ...'
  end
  allowable_values = ["all", "falcon", "third-party"]
  if @api_client.config.client_side_validation && opts[:'search_domain'] && !allowable_values.include?(opts[:'search_domain'])
    fail ArgumentError, "invalid value for \"search_domain\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/dashboards-template/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(['multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['search_domain'] = opts[:'search_domain'] if !opts[:'search_domain'].nil?
  form_params['ids'] = opts[:'ids'] if !opts[:'ids'].nil?
  form_params['yaml_template'] = opts[:'yaml_template'] if !opts[:'yaml_template'].nil?

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

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

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

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

#update_lookup_file(opts = {}) ⇒ ApiUpdateLookupFileResponseV1

Update an entire Lookup File in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_domain (String) —

    name of search domain (view or repo)

  • :filename (String) —

    Filename of the lookup file to update

  • :file (File) —

    file content to upload

Returns:



3011
3012
3013
3014
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 3011

def update_lookup_file(opts = {})
  data, _status_code, _headers = update_lookup_file_with_http_info(opts)
  data
end

#update_lookup_file_entries(opts = {}) ⇒ ApiUpdateLookupFileEntriesResponseV1

Update entries in an existing Lookup File in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_domain (String) —

    name of search domain (view or repo)

  • :filename (String) —

    Filename of the lookup file to update

  • :file (File) —

    The file content for updating or appending the entries

  • :update_mode (String) —

    How to update the file entries

  • :key_columns (String) —

    For update mode, the comma separated list of key columns to use when matching entries (REQUIRED when update_mode&#x3D;update)

  • :ignore_case (String) —

    For update mode, whether to ignore case when matching keys (REQUIRED when update_mode&#x3D;update)

Returns:



3087
3088
3089
3090
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 3087

def update_lookup_file_entries(opts = {})
  data, _status_code, _headers = update_lookup_file_entries_with_http_info(opts)
  data
end

#update_lookup_file_entries_with_http_info(opts = {}) ⇒ Array<(ApiUpdateLookupFileEntriesResponseV1, Integer, Hash)>

Update entries in an existing Lookup File in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_domain (String) —

    name of search domain (view or repo)

  • :filename (String) —

    Filename of the lookup file to update

  • :file (File) —

    The file content for updating or appending the entries

  • :update_mode (String) —

    How to update the file entries

  • :key_columns (String) —

    For update mode, the comma separated list of key columns to use when matching entries (REQUIRED when update_mode&#x3D;update)

  • :ignore_case (String) —

    For update mode, whether to ignore case when matching keys (REQUIRED when update_mode&#x3D;update)

Returns:



3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 3101

def update_lookup_file_entries_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.update_lookup_file_entries ...'
  end
  allowable_values = ["all", "falcon", "third-party", "parsers-repository"]
  if @api_client.config.client_side_validation && opts[:'search_domain'] && !allowable_values.include?(opts[:'search_domain'])
    fail ArgumentError, "invalid value for \"search_domain\", must be one of #{allowable_values}"
  end
  allowable_values = ["append", "update"]
  if @api_client.config.client_side_validation && opts[:'update_mode'] && !allowable_values.include?(opts[:'update_mode'])
    fail ArgumentError, "invalid value for \"update_mode\", must be one of #{allowable_values}"
  end
  allowable_values = ["true", "false"]
  if @api_client.config.client_side_validation && opts[:'ignore_case'] && !allowable_values.include?(opts[:'ignore_case'])
    fail ArgumentError, "invalid value for \"ignore_case\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/lookupfiles-entries/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(['multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['search_domain'] = opts[:'search_domain'] if !opts[:'search_domain'].nil?
  form_params['filename'] = opts[:'filename'] if !opts[:'filename'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['update_mode'] = opts[:'update_mode'] if !opts[:'update_mode'].nil?
  form_params['key_columns'] = opts[:'key_columns'] if !opts[:'key_columns'].nil?
  form_params['ignore_case'] = opts[:'ignore_case'] if !opts[:'ignore_case'].nil?

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

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

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

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

#update_lookup_file_with_http_info(opts = {}) ⇒ Array<(ApiUpdateLookupFileResponseV1, Integer, Hash)>

Update an entire Lookup File in NGSIEM

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_domain (String) —

    name of search domain (view or repo)

  • :filename (String) —

    Filename of the lookup file to update

  • :file (File) —

    file content to upload

Returns:



3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 3022

def update_lookup_file_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.update_lookup_file ...'
  end
  allowable_values = ["all", "falcon", "third-party", "parsers-repository"]
  if @api_client.config.client_side_validation && opts[:'search_domain'] && !allowable_values.include?(opts[:'search_domain'])
    fail ArgumentError, "invalid value for \"search_domain\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/lookupfiles/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(['multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['search_domain'] = opts[:'search_domain'] if !opts[:'search_domain'].nil?
  form_params['filename'] = opts[:'filename'] if !opts[:'filename'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?

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

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

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

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

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

#update_parser(body, opts = {}) ⇒ ApiUpdateParserResponseV1

Update Parser in NGSIEM. Please note that name changes are not supported, but rather should be created as a new parser. This endpoint has been deprecated in favour of the PATCH /entities/parsers-template/v1 API.

Parameters:

Returns:



3172
3173
3174
3175
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 3172

def update_parser(body, opts = {})
  data, _status_code, _headers = update_parser_with_http_info(body, opts)
  data
end

#update_parser_auto_update_policy(body, opts = {}) ⇒ ApiUpdateAutoUpdatePolicyResponseV1

Updates a parser auto update policy - ‘on’ enables auto-updates, ‘off’ disables them

Parameters:

Returns:



3238
3239
3240
3241
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 3238

def update_parser_auto_update_policy(body, opts = {})
  data, _status_code, _headers = update_parser_auto_update_policy_with_http_info(body, opts)
  data
end

#update_parser_auto_update_policy_with_http_info(body, opts = {}) ⇒ Array<(ApiUpdateAutoUpdatePolicyResponseV1, Integer, Hash)>

Updates a parser auto update policy - &#39;on&#39; enables auto-updates, &#39;off&#39; disables them

Parameters:

Returns:



3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 3247

def update_parser_auto_update_policy_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.update_parser_auto_update_policy ...'
  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 Ngsiem.update_parser_auto_update_policy"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/parsers/autoupdate/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] || 'ApiUpdateAutoUpdatePolicyResponseV1'

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

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

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

#update_parser_from_template(opts = {}) ⇒ ApiUpdateParserFromTemplateResponseV1

Update Parser in NGSIEM from YAML Template. Please note that name changes are not supported, but rather should be created as a new parser.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :repository (String) —

    name of repository

  • :ids (String) —

    id of the parser

  • :yaml_template (File) —

    LogScale Parser YAML template content, see schema at schemas.humio.com/

Returns:



3306
3307
3308
3309
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 3306

def update_parser_from_template(opts = {})
  data, _status_code, _headers = update_parser_from_template_with_http_info(opts)
  data
end

#update_parser_from_template_with_http_info(opts = {}) ⇒ Array<(ApiUpdateParserFromTemplateResponseV1, Integer, Hash)>

Update Parser in NGSIEM from YAML Template. Please note that name changes are not supported, but rather should be created as a new parser.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :repository (String) —

    name of repository

  • :ids (String) —

    id of the parser

  • :yaml_template (File) —

    LogScale Parser YAML template content, see schema at schemas.humio.com/

Returns:



3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 3317

def update_parser_from_template_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.update_parser_from_template ...'
  end
  allowable_values = ["parsers-repository"]
  if @api_client.config.client_side_validation && opts[:'repository'] && !allowable_values.include?(opts[:'repository'])
    fail ArgumentError, "invalid value for \"repository\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/parsers-template/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(['multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['repository'] = opts[:'repository'] if !opts[:'repository'].nil?
  form_params['ids'] = opts[:'ids'] if !opts[:'ids'].nil?
  form_params['yaml_template'] = opts[:'yaml_template'] if !opts[:'yaml_template'].nil?

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

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

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

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

#update_parser_with_http_info(body, opts = {}) ⇒ Array<(ApiUpdateParserResponseV1, Integer, Hash)>

Update Parser in NGSIEM. Please note that name changes are not supported, but rather should be created as a new parser. This endpoint has been deprecated in favour of the PATCH /entities/parsers-template/v1 API.

Parameters:

Returns:

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

    ApiUpdateParserResponseV1 data, response status code and response headers



3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 3181

def update_parser_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.update_parser ...'
  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 Ngsiem.update_parser"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/parsers/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] || 'ApiUpdateParserResponseV1'

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

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

#update_saved_query_from_template(opts = {}) ⇒ ApiUpdateSavedQueryResponseV1

Update Saved Query from LogScale YAML Template in NGSIEM.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_domain (String) —

    name of search domain (view or repo)

  • :ids (String) —

    id of the saved query

  • :yaml_template (File) —

    LogScale Saved Query YAML template content, see schema at schemas.humio.com/

Returns:



3379
3380
3381
3382
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 3379

def update_saved_query_from_template(opts = {})
  data, _status_code, _headers = update_saved_query_from_template_with_http_info(opts)
  data
end

#update_saved_query_from_template_with_http_info(opts = {}) ⇒ Array<(ApiUpdateSavedQueryResponseV1, Integer, Hash)>

Update Saved Query from LogScale YAML Template in NGSIEM.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_domain (String) —

    name of search domain (view or repo)

  • :ids (String) —

    id of the saved query

  • :yaml_template (File) —

    LogScale Saved Query YAML template content, see schema at schemas.humio.com/

Returns:



3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 3390

def update_saved_query_from_template_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.update_saved_query_from_template ...'
  end
  allowable_values = ["all", "falcon", "third-party"]
  if @api_client.config.client_side_validation && opts[:'search_domain'] && !allowable_values.include?(opts[:'search_domain'])
    fail ArgumentError, "invalid value for \"search_domain\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ngsiem-content/entities/savedqueries-template/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(['multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['search_domain'] = opts[:'search_domain'] if !opts[:'search_domain'].nil?
  form_params['ids'] = opts[:'ids'] if !opts[:'ids'].nil?
  form_params['yaml_template'] = opts[:'yaml_template'] if !opts[:'yaml_template'].nil?

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

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

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

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

#upload_lookup_v1(repository, file, opts = {}) ⇒ nil

Upload file to NGSIEM

Parameters:

  • repository (String) —

    name of repository

  • file (File) —

    file to upload

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

    the optional parameters

Returns:

  • (nil) 


3451
3452
3453
3454
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 3451

def upload_lookup_v1(repository, file, opts = {})
  upload_lookup_v1_with_http_info(repository, file, opts)
  nil
end

#upload_lookup_v1_with_http_info(repository, file, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Upload file to NGSIEM

Parameters:

  • repository (String) —

    name of repository

  • file (File) —

    file to upload

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
 
# File 'lib/crimson-falcon/api/ngsiem.rb', line 3461

def upload_lookup_v1_with_http_info(repository, file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Ngsiem.upload_lookup_v1 ...'
  end
  # verify the required parameter 'repository' is set
  if @api_client.config.client_side_validation && repository.nil?
    fail ArgumentError, "Missing the required parameter 'repository' when calling Ngsiem.upload_lookup_v1"
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling Ngsiem.upload_lookup_v1"
  end
  # resource path
  local_var_path = '/humio/api/v1/repositories/{repository}/files'.sub('{' + 'repository' + '}', CGI.escape(repository.to_s))

  # 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(['multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

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