Class: Falcon::KubernetesProtection

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ KubernetesProtection

Returns a new instance of KubernetesProtection.



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

def api_client
  @api_client
end

Instance Method Details

#create_aws_account(body, opts = {}) ⇒ K8sregCreateAWSAccResp

Creates a new AWS account in our system for a customer and generates the installation script

Parameters:

Returns:



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

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

#create_aws_account_with_http_info(body, opts = {}) ⇒ Array<(K8sregCreateAWSAccResp, Integer, Hash)>

Creates a new AWS account in our system for a customer and generates the installation script

Parameters:

Returns:

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

    K8sregCreateAWSAccResp data, response status code and response headers



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

def (body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.create_aws_account ...'
  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 KubernetesProtection.create_aws_account"
  end
  # resource path
  local_var_path = '/kubernetes-protection/entities/accounts/aws/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] || 'K8sregCreateAWSAccResp'

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

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

#create_azure_subscription(body, opts = {}) ⇒ MsaBaseEntitiesResponse

Creates a new Azure Subscription in our system

Parameters:

Returns:



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

def create_azure_subscription(body, opts = {})
  data, _status_code, _headers = create_azure_subscription_with_http_info(body, opts)
  data
end

#create_azure_subscription_with_http_info(body, opts = {}) ⇒ Array<(MsaBaseEntitiesResponse, Integer, Hash)>

Creates a new Azure Subscription in our system

Parameters:

Returns:

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

    MsaBaseEntitiesResponse 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/kubernetes_protection.rb', line 117

def create_azure_subscription_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.create_azure_subscription ...'
  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 KubernetesProtection.create_azure_subscription"
  end
  # resource path
  local_var_path = '/kubernetes-protection/entities/accounts/azure/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] || 'MsaBaseEntitiesResponse'

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

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

#delete_aws_accounts(ids, opts = {}) ⇒ MsaMetaInfo

Delete AWS accounts.

Parameters:

  • ids (Array<String>) —

    AWS Account IDs

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

    the optional parameters

Returns:



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

def delete_aws_accounts(ids, opts = {})
  data, _status_code, _headers = delete_aws_accounts_with_http_info(ids, opts)
  data
end

#delete_aws_accounts_with_http_info(ids, opts = {}) ⇒ Array<(MsaMetaInfo, Integer, Hash)>

Delete AWS accounts.

Parameters:

  • ids (Array<String>) —

    AWS Account IDs

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

    the optional parameters

Returns:

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

    MsaMetaInfo data, response status code and response headers



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

def delete_aws_accounts_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.delete_aws_accounts ...'
  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 KubernetesProtection.delete_aws_accounts"
  end
  # resource path
  local_var_path = '/kubernetes-protection/entities/accounts/aws/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] || 'MsaMetaInfo'

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

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

#delete_azure_subscription(opts = {}) ⇒ MsaBaseEntitiesResponse

Deletes a new Azure Subscription in our system

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Azure Subscription IDs

Returns:



236
237
238
239
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 236

def delete_azure_subscription(opts = {})
  data, _status_code, _headers = delete_azure_subscription_with_http_info(opts)
  data
end

#delete_azure_subscription_with_http_info(opts = {}) ⇒ Array<(MsaBaseEntitiesResponse, Integer, Hash)>

Deletes a new Azure Subscription in our system

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Azure Subscription IDs

Returns:

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

    MsaBaseEntitiesResponse data, response status code and response headers



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

def delete_azure_subscription_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.delete_azure_subscription ...'
  end
  # resource path
  local_var_path = '/kubernetes-protection/entities/accounts/azure/v1'

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

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

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

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

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

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

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

#find_containers_by_container_run_time_version(opts = {}) ⇒ ModelsContainerRuntimePivotResponse

Retrieve containers by container_runtime_version

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 200. (default to 200)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

  • :sort (String) —

    The fields to sort the records on.

  • :filter (String) —

    Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:



297
298
299
300
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 297

def find_containers_by_container_run_time_version(opts = {})
  data, _status_code, _headers = find_containers_by_container_run_time_version_with_http_info(opts)
  data
end

#find_containers_by_container_run_time_version_with_http_info(opts = {}) ⇒ Array<(ModelsContainerRuntimePivotResponse, Integer, Hash)>

Retrieve containers by container_runtime_version

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 200. (default to 200)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

  • :sort (String) —

    The fields to sort the records on.

  • :filter (String) —

    Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 309

def find_containers_by_container_run_time_version_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.find_containers_by_container_run_time_version ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/containers/find-by-runtimeversion/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[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?

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

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

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

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

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

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

#find_containers_count_affected_by_zero_day_vulnerabilities(opts = {}) ⇒ CommonCountResponse

Retrieve containers count affected by zero day vulnerabilities

Parameters:

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

    the optional parameters

Returns:



360
361
362
363
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 360

def find_containers_count_affected_by_zero_day_vulnerabilities(opts = {})
  data, _status_code, _headers = find_containers_count_affected_by_zero_day_vulnerabilities_with_http_info(opts)
  data
end

#find_containers_count_affected_by_zero_day_vulnerabilities_with_http_info(opts = {}) ⇒ Array<(CommonCountResponse, Integer, Hash)>

Retrieve containers count affected by zero day vulnerabilities

Parameters:

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

    the optional parameters

Returns:

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

    CommonCountResponse data, response status code and response headers



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 368

def find_containers_count_affected_by_zero_day_vulnerabilities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.find_containers_count_affected_by_zero_day_vulnerabilities ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/containers/count-by-zero-day/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'])

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

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

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

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

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

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

#get_aws_accounts(opts = {}) ⇒ K8sregGetAWSAccountsResp

Provides a list of AWS accounts.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    AWS Account IDs

  • :is_horizon_acct (String) —

    Filter by whether an account originates from Horizon or not

  • :status (String) —

    Filter by account status

  • :limit (Integer) —

    Limit returned accounts

  • :offset (Integer) —

    Offset returned accounts

Returns:



420
421
422
423
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 420

def get_aws_accounts(opts = {})
  data, _status_code, _headers = get_aws_accounts_with_http_info(opts)
  data
end

#get_aws_accounts_with_http_info(opts = {}) ⇒ Array<(K8sregGetAWSAccountsResp, Integer, Hash)>

Provides a list of AWS accounts.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    AWS Account IDs

  • :is_horizon_acct (String) —

    Filter by whether an account originates from Horizon or not

  • :status (String) —

    Filter by account status

  • :limit (Integer) —

    Limit returned accounts

  • :offset (Integer) —

    Offset returned accounts

Returns:

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

    K8sregGetAWSAccountsResp data, response status code and response headers



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 433

def get_aws_accounts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.get_aws_accounts ...'
  end
  allowable_values = ["false", "true"]
  if @api_client.config.client_side_validation && opts[:'is_horizon_acct'] && !allowable_values.include?(opts[:'is_horizon_acct'])
    fail ArgumentError, "invalid value for \"is_horizon_acct\", must be one of #{allowable_values}"
  end
  pattern = Regexp.new(/^(true|false)$/)
  if @api_client.config.client_side_validation && !opts[:'is_horizon_acct'].nil? && opts[:'is_horizon_acct'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"is_horizon_acct\"]' when calling KubernetesProtection.get_aws_accounts, must conform to the pattern #{pattern}."
  end

  allowable_values = ["operational", "provisioned"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  pattern = Regexp.new(/^(provisioned|operational)$/)
  if @api_client.config.client_side_validation && !opts[:'status'].nil? && opts[:'status'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"status\"]' when calling KubernetesProtection.get_aws_accounts, must conform to the pattern #{pattern}."
  end

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

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

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

  # resource path
  local_var_path = '/kubernetes-protection/entities/accounts/aws/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'is_horizon_acct'] = opts[:'is_horizon_acct'] if !opts[:'is_horizon_acct'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

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

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

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

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

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

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

#get_azure_install_script(opts = {}) ⇒ K8sregGetAzureBashScriptResp

Provides the script to run for a given tenant id and subscription IDs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    Azure Tenant ID

  • :subscription_id (Array<String>) —

    Azure Subscription IDs

Returns:



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

def get_azure_install_script(opts = {})
  data, _status_code, _headers = get_azure_install_script_with_http_info(opts)
  data
end

#get_azure_install_script_with_http_info(opts = {}) ⇒ Array<(K8sregGetAzureBashScriptResp, Integer, Hash)>

Provides the script to run for a given tenant id and subscription IDs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    Azure Tenant ID

  • :subscription_id (Array<String>) —

    Azure Subscription IDs

Returns:



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

def get_azure_install_script_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.get_azure_install_script ...'
  end
  if @api_client.config.client_side_validation && !opts[:'id'].nil? && opts[:'id'].to_s.length > 36
    fail ArgumentError, 'invalid value for "opts[:"id"]" when calling KubernetesProtection.get_azure_install_script, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && !opts[:'id'].nil? && opts[:'id'].to_s.length < 36
    fail ArgumentError, 'invalid value for "opts[:"id"]" when calling KubernetesProtection.get_azure_install_script, the character length must be great than or equal to 36.'
  end

  pattern = Regexp.new(/^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$/)
  if @api_client.config.client_side_validation && !opts[:'id'].nil? && opts[:'id'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"id\"]' when calling KubernetesProtection.get_azure_install_script, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/kubernetes-protection/entities/user-script/azure/v1'

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

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

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

#get_azure_tenant_config(opts = {}) ⇒ K8sregGetAzureTenantConfigResp

Gets the Azure tenant Config

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Azure Tenant IDs

  • :limit (Integer) —

    Limit returned accounts

  • :offset (Integer) —

    Offset returned accounts

Returns:



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

def get_azure_tenant_config(opts = {})
  data, _status_code, _headers = get_azure_tenant_config_with_http_info(opts)
  data
end

#get_azure_tenant_config_with_http_info(opts = {}) ⇒ Array<(K8sregGetAzureTenantConfigResp, Integer, Hash)>

Gets the Azure tenant Config

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Azure Tenant IDs

  • :limit (Integer) —

    Limit returned accounts

  • :offset (Integer) —

    Offset returned accounts

Returns:



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

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

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

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

  # resource path
  local_var_path = '/kubernetes-protection/entities/config/azure/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

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

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

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

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

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

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

#get_azure_tenant_ids(opts = {}) ⇒ K8sregGetAzureTenantInfoResp

Provides all the azure subscriptions and tenants

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Azure Tenant IDs

  • :status (String) —

    Cluster Status

  • :limit (Integer) —

    Limit returned accounts

  • :offset (Integer) —

    Offset returned accounts

Returns:



669
670
671
672
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 669

def get_azure_tenant_ids(opts = {})
  data, _status_code, _headers = get_azure_tenant_ids_with_http_info(opts)
  data
end

#get_azure_tenant_ids_with_http_info(opts = {}) ⇒ Array<(K8sregGetAzureTenantInfoResp, Integer, Hash)>

Provides all the azure subscriptions and tenants

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Azure Tenant IDs

  • :status (String) —

    Cluster Status

  • :limit (Integer) —

    Limit returned accounts

  • :offset (Integer) —

    Offset returned accounts

Returns:



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

def get_azure_tenant_ids_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.get_azure_tenant_ids ...'
  end
  allowable_values = ["Not Installed", "Running", "Stopped"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling KubernetesProtection.get_azure_tenant_ids, must be smaller than or equal to 1000.'
  end

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

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

  # resource path
  local_var_path = '/kubernetes-protection/entities/tenants/azure/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

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

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

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

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

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

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

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

#get_clusters(opts = {}) ⇒ K8sregGetClustersResp

Provides the clusters acknowledged by the Kubernetes Protection service

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cluster_names (Array<String>) —

    Cluster name. For EKS it will be cluster ARN.

  • :status (Array<String>) —

    Cluster Status

  • :account_ids (Array<String>) —

    Cluster Account id. For EKS it will be AWS account ID.

  • :locations (Array<String>) —

    Cloud location

  • :cluster_service (String) —

    Cluster Service

  • :limit (Integer) —

    Limit returned accounts

  • :offset (Integer) —

    Offset returned accounts

Returns:



755
756
757
758
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 755

def get_clusters(opts = {})
  data, _status_code, _headers = get_clusters_with_http_info(opts)
  data
end

#get_clusters_with_http_info(opts = {}) ⇒ Array<(K8sregGetClustersResp, Integer, Hash)>

Provides the clusters acknowledged by the Kubernetes Protection service

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cluster_names (Array<String>) —

    Cluster name. For EKS it will be cluster ARN.

  • :status (Array<String>) —

    Cluster Status

  • :account_ids (Array<String>) —

    Cluster Account id. For EKS it will be AWS account ID.

  • :locations (Array<String>) —

    Cloud location

  • :cluster_service (String) —

    Cluster Service

  • :limit (Integer) —

    Limit returned accounts

  • :offset (Integer) —

    Offset returned accounts

Returns:

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

    K8sregGetClustersResp data, response status code and response headers



770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
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
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 770

def get_clusters_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.get_clusters ...'
  end
  allowable_values = []
  if @api_client.config.client_side_validation && opts[:'status'] && !opts[:'status'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"status\", must include one of #{allowable_values}"
  end
  allowable_values = ["aks", "eks"]
  if @api_client.config.client_side_validation && opts[:'cluster_service'] && !allowable_values.include?(opts[:'cluster_service'])
    fail ArgumentError, "invalid value for \"cluster_service\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling KubernetesProtection.get_clusters, must be smaller than or equal to 1000.'
  end

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

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

  # resource path
  local_var_path = '/kubernetes-protection/entities/kubernetes/clusters/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cluster_names'] = @api_client.build_collection_param(opts[:'cluster_names'], :csv) if !opts[:'cluster_names'].nil?
  query_params[:'status'] = @api_client.build_collection_param(opts[:'status'], :csv) if !opts[:'status'].nil?
  query_params[:'account_ids'] = @api_client.build_collection_param(opts[:'account_ids'], :csv) if !opts[:'account_ids'].nil?
  query_params[:'locations'] = @api_client.build_collection_param(opts[:'locations'], :csv) if !opts[:'locations'].nil?
  query_params[:'cluster_service'] = opts[:'cluster_service'] if !opts[:'cluster_service'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

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

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

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

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

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

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

#get_combined_cloud_clusters(opts = {}) ⇒ K8sregListClusterCloudResp

Returns a combined list of provisioned cloud accounts and known kubernetes clusters

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :locations (Array<String>) —

    Cloud location

  • :ids (Array<String>) —

    Cloud Account IDs

  • :cluster_service (Array<String>) —

    Cluster Service

  • :cluster_status (Array<String>) —

    Cluster Status

  • :limit (Integer) —

    Limit returned accounts

  • :offset (Integer) —

    Offset returned accounts

Returns:



850
851
852
853
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 850

def get_combined_cloud_clusters(opts = {})
  data, _status_code, _headers = get_combined_cloud_clusters_with_http_info(opts)
  data
end

#get_combined_cloud_clusters_with_http_info(opts = {}) ⇒ Array<(K8sregListClusterCloudResp, Integer, Hash)>

Returns a combined list of provisioned cloud accounts and known kubernetes clusters

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :locations (Array<String>) —

    Cloud location

  • :ids (Array<String>) —

    Cloud Account IDs

  • :cluster_service (Array<String>) —

    Cluster Service

  • :cluster_status (Array<String>) —

    Cluster Status

  • :limit (Integer) —

    Limit returned accounts

  • :offset (Integer) —

    Offset returned accounts

Returns:

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

    K8sregListClusterCloudResp data, response status code and response headers



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
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 864

def get_combined_cloud_clusters_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.get_combined_cloud_clusters ...'
  end
  allowable_values = []
  if @api_client.config.client_side_validation && opts[:'cluster_service'] && !opts[:'cluster_service'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"cluster_service\", must include one of #{allowable_values}"
  end
  allowable_values = []
  if @api_client.config.client_side_validation && opts[:'cluster_status'] && !opts[:'cluster_status'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"cluster_status\", must include one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling KubernetesProtection.get_combined_cloud_clusters, must be smaller than or equal to 1000.'
  end

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

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

  # resource path
  local_var_path = '/kubernetes-protection/entities/cloud_cluster/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'locations'] = @api_client.build_collection_param(opts[:'locations'], :csv) if !opts[:'locations'].nil?
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'cluster_service'] = @api_client.build_collection_param(opts[:'cluster_service'], :csv) if !opts[:'cluster_service'].nil?
  query_params[:'cluster_status'] = @api_client.build_collection_param(opts[:'cluster_status'], :csv) if !opts[:'cluster_status'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

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

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

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

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

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

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

#get_helm_values_yaml(cluster_name, opts = {}) ⇒ Object

Provides a sample Helm values.yaml file for a customer to install alongside the agent Helm chart

Parameters:

  • cluster_name (String) —

    Cluster name. For EKS it will be cluster ARN.

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

    the optional parameters

Options Hash (opts):

  • :is_self_managed_cluster (Boolean) —

    Set to true if the cluster is not managed by a cloud provider, false if it is.

Returns:

  • (Object) 


939
940
941
942
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 939

def get_helm_values_yaml(cluster_name, opts = {})
  data, _status_code, _headers = get_helm_values_yaml_with_http_info(cluster_name, opts)
  data
end

#get_helm_values_yaml_with_http_info(cluster_name, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Provides a sample Helm values.yaml file for a customer to install alongside the agent Helm chart

Parameters:

  • cluster_name (String) —

    Cluster name. For EKS it will be cluster ARN.

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

    the optional parameters

Options Hash (opts):

  • :is_self_managed_cluster (Boolean) —

    Set to true if the cluster is not managed by a cloud provider, false if it is.

Returns:

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

    Object data, response status code and response headers



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

def get_helm_values_yaml_with_http_info(cluster_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.get_helm_values_yaml ...'
  end
  # verify the required parameter 'cluster_name' is set
  if @api_client.config.client_side_validation && cluster_name.nil?
    fail ArgumentError, "Missing the required parameter 'cluster_name' when calling KubernetesProtection.get_helm_values_yaml"
  end
  # resource path
  local_var_path = '/kubernetes-protection/entities/integration/agent/v1'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/yaml', '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] || 'Object'

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

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

#get_locations(opts = {}) ⇒ K8sregGetLocationsResp

Provides the cloud locations acknowledged by the Kubernetes Protection service

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :clouds (Array<String>) —

    Cloud Provider

Returns:



1003
1004
1005
1006
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1003

def get_locations(opts = {})
  data, _status_code, _headers = get_locations_with_http_info(opts)
  data
end

#get_locations_with_http_info(opts = {}) ⇒ Array<(K8sregGetLocationsResp, Integer, Hash)>

Provides the cloud locations acknowledged by the Kubernetes Protection service

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :clouds (Array<String>) —

    Cloud Provider

Returns:

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

    K8sregGetLocationsResp data, response status code and response headers



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

def get_locations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.get_locations ...'
  end
  allowable_values = []
  if @api_client.config.client_side_validation && opts[:'clouds'] && !opts[:'clouds'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"clouds\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/kubernetes-protection/entities/cloud-locations/v1'

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

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

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

#get_static_scripts(opts = {}) ⇒ K8sregGetScriptsResp

Gets static bash scripts that are used during registration

Parameters:

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

    the optional parameters

Returns:



1064
1065
1066
1067
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1064

def get_static_scripts(opts = {})
  data, _status_code, _headers = get_static_scripts_with_http_info(opts)
  data
end

#get_static_scripts_with_http_info(opts = {}) ⇒ Array<(K8sregGetScriptsResp, Integer, Hash)>

Gets static bash scripts that are used during registration

Parameters:

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

    the optional parameters

Returns:

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

    K8sregGetScriptsResp data, response status code and response headers



1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1072

def get_static_scripts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.get_static_scripts ...'
  end
  # resource path
  local_var_path = '/kubernetes-protection/entities/gen/scripts/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'])

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

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

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

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

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

#group_containers_by_managed(opts = {}) ⇒ ModelsContainerCoverageResponseEntity

Group the containers by Managed

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:



1120
1121
1122
1123
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1120

def group_containers_by_managed(opts = {})
  data, _status_code, _headers = group_containers_by_managed_with_http_info(opts)
  data
end

#group_containers_by_managed_with_http_info(opts = {}) ⇒ Array<(ModelsContainerCoverageResponseEntity, Integer, Hash)>

Group the containers by Managed

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:



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

def group_containers_by_managed_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.group_containers_by_managed ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/containers/group-by-managed/v1'

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

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

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

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

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

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

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

#list_azure_accounts(opts = {}) ⇒ K8sregGetAzureSubscriptionsResp

Provides the azure subscriptions registered to Kubernetes Protection

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Azure Tenant IDs

  • :subscription_id (Array<String>) —

    Azure Subscription IDs

  • :status (String) —

    Filter by account status

  • :is_horizon_acct (String) —

    Filter by whether an account originates from Horizon or not

  • :limit (Integer) —

    Limit returned accounts

  • :offset (Integer) —

    Offset returned accounts

Returns:



1183
1184
1185
1186
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1183

def list_azure_accounts(opts = {})
  data, _status_code, _headers = list_azure_accounts_with_http_info(opts)
  data
end

#list_azure_accounts_with_http_info(opts = {}) ⇒ Array<(K8sregGetAzureSubscriptionsResp, Integer, Hash)>

Provides the azure subscriptions registered to Kubernetes Protection

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Azure Tenant IDs

  • :subscription_id (Array<String>) —

    Azure Subscription IDs

  • :status (String) —

    Filter by account status

  • :is_horizon_acct (String) —

    Filter by whether an account originates from Horizon or not

  • :limit (Integer) —

    Limit returned accounts

  • :offset (Integer) —

    Offset returned accounts

Returns:



1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1197

def list_azure_accounts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.list_azure_accounts ...'
  end
  allowable_values = ["operational", "provisioned"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  pattern = Regexp.new(/^(provisioned|operational)$/)
  if @api_client.config.client_side_validation && !opts[:'status'].nil? && opts[:'status'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"status\"]' when calling KubernetesProtection.list_azure_accounts, must conform to the pattern #{pattern}."
  end

  allowable_values = ["false", "true"]
  if @api_client.config.client_side_validation && opts[:'is_horizon_acct'] && !allowable_values.include?(opts[:'is_horizon_acct'])
    fail ArgumentError, "invalid value for \"is_horizon_acct\", must be one of #{allowable_values}"
  end
  pattern = Regexp.new(/^(true|false)$/)
  if @api_client.config.client_side_validation && !opts[:'is_horizon_acct'].nil? && opts[:'is_horizon_acct'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"is_horizon_acct\"]' when calling KubernetesProtection.list_azure_accounts, must conform to the pattern #{pattern}."
  end

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

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

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

  # resource path
  local_var_path = '/kubernetes-protection/entities/accounts/azure/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
  query_params[:'subscription_id'] = @api_client.build_collection_param(opts[:'subscription_id'], :csv) if !opts[:'subscription_id'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'is_horizon_acct'] = opts[:'is_horizon_acct'] if !opts[:'is_horizon_acct'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

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

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

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

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

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

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

#patch_azure_service_principal(id, client_id, opts = {}) ⇒ K8sregGetAzureTenantConfigResp

Adds the client ID for the given tenant ID to our system

Parameters:

  • id (String) —

    Azure Tenant ID

  • client_id (String) —

    Azure Client ID

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

    the optional parameters

Returns:



1282
1283
1284
1285
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1282

def patch_azure_service_principal(id, client_id, opts = {})
  data, _status_code, _headers = patch_azure_service_principal_with_http_info(id, client_id, opts)
  data
end

#patch_azure_service_principal_with_http_info(id, client_id, opts = {}) ⇒ Array<(K8sregGetAzureTenantConfigResp, Integer, Hash)>

Adds the client ID for the given tenant ID to our system

Parameters:

  • id (String) —

    Azure Tenant ID

  • client_id (String) —

    Azure Client ID

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

    the optional parameters

Returns:



1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
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
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1292

def patch_azure_service_principal_with_http_info(id, client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.patch_azure_service_principal ...'
  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 KubernetesProtection.patch_azure_service_principal"
  end
  if @api_client.config.client_side_validation && id.to_s.length > 36
    fail ArgumentError, 'invalid value for "id" when calling KubernetesProtection.patch_azure_service_principal, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && id.to_s.length < 36
    fail ArgumentError, 'invalid value for "id" when calling KubernetesProtection.patch_azure_service_principal, the character length must be great than or equal to 36.'
  end

  pattern = Regexp.new(/^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$/)
  if @api_client.config.client_side_validation && id !~ pattern
    fail ArgumentError, "invalid value for 'id' when calling KubernetesProtection.patch_azure_service_principal, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'client_id' is set
  if @api_client.config.client_side_validation && client_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_id' when calling KubernetesProtection.patch_azure_service_principal"
  end
  if @api_client.config.client_side_validation && client_id.to_s.length > 36
    fail ArgumentError, 'invalid value for "client_id" when calling KubernetesProtection.patch_azure_service_principal, the character length must be smaller than or equal to 36.'
  end

  if @api_client.config.client_side_validation && client_id.to_s.length < 36
    fail ArgumentError, 'invalid value for "client_id" when calling KubernetesProtection.patch_azure_service_principal, the character length must be great than or equal to 36.'
  end

  pattern = Regexp.new(/^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$/)
  if @api_client.config.client_side_validation && client_id !~ pattern
    fail ArgumentError, "invalid value for 'client_id' when calling KubernetesProtection.patch_azure_service_principal, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/kubernetes-protection/entities/service-principal/azure/v1'

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

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

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

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

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

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

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

#post_search_kubernetes_iom_entities(body, opts = {}) ⇒ K8siomsSearchResponse

Search for Kubernetes IOMs with filtering options.Pagination is supported via Elasticsearch’s search_after search param and point in time. Assets are sorted by unique ID in ascending direction.

Parameters:

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes IOMs using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;cid&#x60; - &#x60;cis_id&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;containers_impacted_ai_related&#x60; - &#x60;containers_impacted_count&#x60; - &#x60;containers_impacted_ids&#x60; - &#x60;detection_type&#x60; - &#x60;name&#x60; - &#x60;namespace&#x60; - &#x60;prevented&#x60; - &#x60;resource_id&#x60; - &#x60;resource_name&#x60; - &#x60;resource_type&#x60; - &#x60;severity&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    Maximum number of records to return (default: 100, max: 500) (default to 100)

Returns:



1379
1380
1381
1382
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1379

def post_search_kubernetes_iom_entities(body, opts = {})
  data, _status_code, _headers = post_search_kubernetes_iom_entities_with_http_info(body, opts)
  data
end

#post_search_kubernetes_iom_entities_with_http_info(body, opts = {}) ⇒ Array<(K8siomsSearchResponse, Integer, Hash)>

Search for Kubernetes IOMs with filtering options.Pagination is supported via Elasticsearch&#39;s search_after search param and point in time. Assets are sorted by unique ID in ascending direction.

Parameters:

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes IOMs using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;cid&#x60; - &#x60;cis_id&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;containers_impacted_ai_related&#x60; - &#x60;containers_impacted_count&#x60; - &#x60;containers_impacted_ids&#x60; - &#x60;detection_type&#x60; - &#x60;name&#x60; - &#x60;namespace&#x60; - &#x60;prevented&#x60; - &#x60;resource_id&#x60; - &#x60;resource_name&#x60; - &#x60;resource_type&#x60; - &#x60;severity&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    Maximum number of records to return (default: 100, max: 500) (default to 100)

Returns:

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

    K8siomsSearchResponse data, response status code and response headers



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
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1391

def post_search_kubernetes_iom_entities_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.post_search_kubernetes_iom_entities ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling KubernetesProtection.post_search_kubernetes_iom_entities"
  end
  # resource path
  local_var_path = '/container-security/combined/kubernetes-ioms/search/v1'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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] || 'K8siomsSearchResponse'

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

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

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

#read_cluster_combined(opts = {}) ⇒ ModelsClusterEntityResponse

Retrieve kubernetes clusters identified by the provided filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes clusters using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;access&#x60; - &#x60;agent_id&#x60; - &#x60;agent_status&#x60; - &#x60;agent_type&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;cluster_status&#x60; - &#x60;container_count&#x60; - &#x60;iar_coverage&#x60; - &#x60;kac_agent_id&#x60; - &#x60;kubernetes_version&#x60; - &#x60;last_seen&#x60; - &#x60;management_status&#x60; - &#x60;namespace&#x60; - &#x60;node_count&#x60; - &#x60;pod_count&#x60; - &#x60;pod_name&#x60; - &#x60;tags&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 200. (default to 200)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

Returns:



1454
1455
1456
1457
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1454

def read_cluster_combined(opts = {})
  data, _status_code, _headers = read_cluster_combined_with_http_info(opts)
  data
end

#read_cluster_combined_v2(opts = {}) ⇒ V2ClusterEntityResponseV2

Retrieve Kubernetes cluster data

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes clusters using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;access&#x60; - &#x60;agent_id&#x60; - &#x60;agent_status&#x60; - &#x60;agent_type&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;cluster_status&#x60; - &#x60;container_count&#x60; - &#x60;iar_coverage&#x60; - &#x60;kac_agent_id&#x60; - &#x60;kubernetes_version&#x60; - &#x60;last_seen&#x60; - &#x60;management_status&#x60; - &#x60;namespace&#x60; - &#x60;node_count&#x60; - &#x60;pod_count&#x60; - &#x60;pod_name&#x60; - &#x60;tags&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :include_counts (Boolean) —

    Flag to include node, pod and container counts in the response

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 200. (default to 200)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

Returns:



1522
1523
1524
1525
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1522

def read_cluster_combined_v2(opts = {})
  data, _status_code, _headers = read_cluster_combined_v2_with_http_info(opts)
  data
end

#read_cluster_combined_v2_with_http_info(opts = {}) ⇒ Array<(V2ClusterEntityResponseV2, Integer, Hash)>

Retrieve Kubernetes cluster data

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes clusters using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;access&#x60; - &#x60;agent_id&#x60; - &#x60;agent_status&#x60; - &#x60;agent_type&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;cluster_status&#x60; - &#x60;container_count&#x60; - &#x60;iar_coverage&#x60; - &#x60;kac_agent_id&#x60; - &#x60;kubernetes_version&#x60; - &#x60;last_seen&#x60; - &#x60;management_status&#x60; - &#x60;namespace&#x60; - &#x60;node_count&#x60; - &#x60;pod_count&#x60; - &#x60;pod_name&#x60; - &#x60;tags&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :include_counts (Boolean) —

    Flag to include node, pod and container counts in the response

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 200. (default to 200)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

Returns:

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

    V2ClusterEntityResponseV2 data, response status code and response headers



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
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1535

def read_cluster_combined_v2_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_cluster_combined_v2 ...'
  end
  # resource path
  local_var_path = '/container-security/combined/clusters/v2'

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

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

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

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

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

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

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

#read_cluster_combined_with_http_info(opts = {}) ⇒ Array<(ModelsClusterEntityResponse, Integer, Hash)>

Retrieve kubernetes clusters identified by the provided filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes clusters using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;access&#x60; - &#x60;agent_id&#x60; - &#x60;agent_status&#x60; - &#x60;agent_type&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;cluster_status&#x60; - &#x60;container_count&#x60; - &#x60;iar_coverage&#x60; - &#x60;kac_agent_id&#x60; - &#x60;kubernetes_version&#x60; - &#x60;last_seen&#x60; - &#x60;management_status&#x60; - &#x60;namespace&#x60; - &#x60;node_count&#x60; - &#x60;pod_count&#x60; - &#x60;pod_name&#x60; - &#x60;tags&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 200. (default to 200)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

Returns:

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

    ModelsClusterEntityResponse data, response status code and response headers



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
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1466

def read_cluster_combined_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_cluster_combined ...'
  end
  # resource path
  local_var_path = '/container-security/combined/clusters/v1'

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

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

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

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

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

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

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

#read_cluster_count(opts = {}) ⇒ CommonCountResponse

Retrieve cluster counts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes clusters that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;access&#x60; - &#x60;agent_id&#x60; - &#x60;agent_status&#x60; - &#x60;agent_type&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;cluster_status&#x60; - &#x60;container_count&#x60; - &#x60;iar_coverage&#x60; - &#x60;kac_agent_id&#x60; - &#x60;kubernetes_version&#x60; - &#x60;last_seen&#x60; - &#x60;management_status&#x60; - &#x60;namespace&#x60; - &#x60;node_count&#x60; - &#x60;pod_count&#x60; - &#x60;pod_name&#x60; - &#x60;tags&#x60;

Returns:



1588
1589
1590
1591
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1588

def read_cluster_count(opts = {})
  data, _status_code, _headers = read_cluster_count_with_http_info(opts)
  data
end

#read_cluster_count_with_http_info(opts = {}) ⇒ Array<(CommonCountResponse, Integer, Hash)>

Retrieve cluster counts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes clusters that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;access&#x60; - &#x60;agent_id&#x60; - &#x60;agent_status&#x60; - &#x60;agent_type&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;cluster_status&#x60; - &#x60;container_count&#x60; - &#x60;iar_coverage&#x60; - &#x60;kac_agent_id&#x60; - &#x60;kubernetes_version&#x60; - &#x60;last_seen&#x60; - &#x60;management_status&#x60; - &#x60;namespace&#x60; - &#x60;node_count&#x60; - &#x60;pod_count&#x60; - &#x60;pod_name&#x60; - &#x60;tags&#x60;

Returns:

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

    CommonCountResponse data, response status code and response headers



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
1638
1639
1640
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1597

def read_cluster_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_cluster_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/clusters/count/v1'

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

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

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

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

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

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

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

#read_cluster_enrichment(cluster_id, opts = {}) ⇒ K8sassetsClusterEnrichmentResponse

Retrieve cluster enrichment data

Parameters:

  • cluster_id (Array<String>) —

    One or more cluster ids for which to retrieve enrichment info

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Supported filter fields: - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60;

Returns:



1647
1648
1649
1650
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1647

def read_cluster_enrichment(cluster_id, opts = {})
  data, _status_code, _headers = read_cluster_enrichment_with_http_info(cluster_id, opts)
  data
end

#read_cluster_enrichment_with_http_info(cluster_id, opts = {}) ⇒ Array<(K8sassetsClusterEnrichmentResponse, Integer, Hash)>

Retrieve cluster enrichment data

Parameters:

  • cluster_id (Array<String>) —

    One or more cluster ids for which to retrieve enrichment info

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Supported filter fields: - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60;

Returns:



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

def read_cluster_enrichment_with_http_info(cluster_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_cluster_enrichment ...'
  end
  # verify the required parameter 'cluster_id' is set
  if @api_client.config.client_side_validation && cluster_id.nil?
    fail ArgumentError, "Missing the required parameter 'cluster_id' when calling KubernetesProtection.read_cluster_enrichment"
  end
  # resource path
  local_var_path = '/container-security/aggregates/enrichment/clusters/entities/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cluster_id'] = @api_client.build_collection_param(cluster_id, :csv)
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?

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

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

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

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

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

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

#read_clusters_by_date_range_count(opts = {}) ⇒ ModelsAggregateValuesByFieldResponse

Retrieve clusters by date range counts

Parameters:

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

    the optional parameters

Returns:



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

def read_clusters_by_date_range_count(opts = {})
  data, _status_code, _headers = read_clusters_by_date_range_count_with_http_info(opts)
  data
end

#read_clusters_by_date_range_count_with_http_info(opts = {}) ⇒ Array<(ModelsAggregateValuesByFieldResponse, Integer, Hash)>

Retrieve clusters by date range counts

Parameters:

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

    the optional parameters

Returns:



1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1718

def read_clusters_by_date_range_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_clusters_by_date_range_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/clusters/count-by-date/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'])

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

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

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

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

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

#read_clusters_by_kubernetes_version_count(opts = {}) ⇒ ModelsAggregateValuesByFieldResponse

Bucket clusters by kubernetes version

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes clusters that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;access&#x60; - &#x60;agent_id&#x60; - &#x60;agent_status&#x60; - &#x60;agent_type&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;cluster_status&#x60; - &#x60;container_count&#x60; - &#x60;iar_coverage&#x60; - &#x60;kac_agent_id&#x60; - &#x60;kubernetes_version&#x60; - &#x60;last_seen&#x60; - &#x60;management_status&#x60; - &#x60;namespace&#x60; - &#x60;node_count&#x60; - &#x60;pod_count&#x60; - &#x60;pod_name&#x60; - &#x60;tags&#x60;

Returns:



1766
1767
1768
1769
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1766

def read_clusters_by_kubernetes_version_count(opts = {})
  data, _status_code, _headers = read_clusters_by_kubernetes_version_count_with_http_info(opts)
  data
end

#read_clusters_by_kubernetes_version_count_with_http_info(opts = {}) ⇒ Array<(ModelsAggregateValuesByFieldResponse, Integer, Hash)>

Bucket clusters by kubernetes version

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes clusters that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;access&#x60; - &#x60;agent_id&#x60; - &#x60;agent_status&#x60; - &#x60;agent_type&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;cluster_status&#x60; - &#x60;container_count&#x60; - &#x60;iar_coverage&#x60; - &#x60;kac_agent_id&#x60; - &#x60;kubernetes_version&#x60; - &#x60;last_seen&#x60; - &#x60;management_status&#x60; - &#x60;namespace&#x60; - &#x60;node_count&#x60; - &#x60;pod_count&#x60; - &#x60;pod_name&#x60; - &#x60;tags&#x60;

Returns:



1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1775

def read_clusters_by_kubernetes_version_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_clusters_by_kubernetes_version_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/clusters/count-by-kubernetes-version/v1'

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

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

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

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

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

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

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

#read_clusters_by_status_count(opts = {}) ⇒ ModelsAggregateValuesByFieldResponse

Bucket clusters by status

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes clusters that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;access&#x60; - &#x60;agent_id&#x60; - &#x60;agent_status&#x60; - &#x60;agent_type&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;cluster_status&#x60; - &#x60;container_count&#x60; - &#x60;iar_coverage&#x60; - &#x60;kac_agent_id&#x60; - &#x60;kubernetes_version&#x60; - &#x60;last_seen&#x60; - &#x60;management_status&#x60; - &#x60;namespace&#x60; - &#x60;node_count&#x60; - &#x60;pod_count&#x60; - &#x60;pod_name&#x60; - &#x60;tags&#x60;

Returns:



1824
1825
1826
1827
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1824

def read_clusters_by_status_count(opts = {})
  data, _status_code, _headers = read_clusters_by_status_count_with_http_info(opts)
  data
end

#read_clusters_by_status_count_with_http_info(opts = {}) ⇒ Array<(ModelsAggregateValuesByFieldResponse, Integer, Hash)>

Bucket clusters by status

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes clusters that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;access&#x60; - &#x60;agent_id&#x60; - &#x60;agent_status&#x60; - &#x60;agent_type&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;cluster_status&#x60; - &#x60;container_count&#x60; - &#x60;iar_coverage&#x60; - &#x60;kac_agent_id&#x60; - &#x60;kubernetes_version&#x60; - &#x60;last_seen&#x60; - &#x60;management_status&#x60; - &#x60;namespace&#x60; - &#x60;node_count&#x60; - &#x60;pod_count&#x60; - &#x60;pod_name&#x60; - &#x60;tags&#x60;

Returns:



1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1833

def read_clusters_by_status_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_clusters_by_status_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/clusters/count-by-status/v1'

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

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

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

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

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

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

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

#read_container_combined(opts = {}) ⇒ ModelsContainerEntityResponse

Retrieves a paginated list of containers identified by the provided filter criteria. Maximum page size: 200. Maximum available containers: 10,000

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes containers using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 200. (default to 200)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

Returns:



1885
1886
1887
1888
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1885

def read_container_combined(opts = {})
  data, _status_code, _headers = read_container_combined_with_http_info(opts)
  data
end

#read_container_combined_with_http_info(opts = {}) ⇒ Array<(ModelsContainerEntityResponse, Integer, Hash)>

Retrieves a paginated list of containers identified by the provided filter criteria. Maximum page size: 200. Maximum available containers: 10,000

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes containers using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 200. (default to 200)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

Returns:



1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1897

def read_container_combined_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_container_combined ...'
  end
  # resource path
  local_var_path = '/container-security/combined/containers/v1'

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

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

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

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

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

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

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

#read_container_count(opts = {}) ⇒ CommonCountResponse

Retrieve container counts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:



1949
1950
1951
1952
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1949

def read_container_count(opts = {})
  data, _status_code, _headers = read_container_count_with_http_info(opts)
  data
end

#read_container_count_by_registry(opts = {}) ⇒ ModelsAPIFilterResponse

Retrieves a list with the top container image registries. Maximum page size: 200

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :under_assessment (Boolean) — default: true/false —

    whether to return registries under assessment or not under assessment. If not provided all registries are considered (default to false)

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve.

  • :filter (String) —

    Retrieve count of Kubernetes container image registries that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:



2009
2010
2011
2012
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2009

def read_container_count_by_registry(opts = {})
  data, _status_code, _headers = read_container_count_by_registry_with_http_info(opts)
  data
end

#read_container_count_by_registry_with_http_info(opts = {}) ⇒ Array<(ModelsAPIFilterResponse, Integer, Hash)>

Retrieves a list with the top container image registries. Maximum page size: 200

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :under_assessment (Boolean) — default: true/false —

    whether to return registries under assessment or not under assessment. If not provided all registries are considered (default to false)

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve.

  • :filter (String) —

    Retrieve count of Kubernetes container image registries that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:

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

    ModelsAPIFilterResponse data, response status code and response headers



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

def read_container_count_by_registry_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_container_count_by_registry ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/containers/count-by-registry/v1'

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

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

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

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

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

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

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

#read_container_count_with_http_info(opts = {}) ⇒ Array<(CommonCountResponse, Integer, Hash)>

Retrieve container counts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:

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

    CommonCountResponse data, response status code and response headers



1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 1958

def read_container_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_container_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/containers/count/v1'

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

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

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

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

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

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

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

#read_container_enrichment(container_id, opts = {}) ⇒ K8sassetsContainerEnrichmentResponse

Retrieve container enrichment data

Parameters:

  • container_id (Array<String>) —

    One or more container ids for which to retrieve enrichment info

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Supported filter fields: - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60;

Returns:



2072
2073
2074
2075
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2072

def read_container_enrichment(container_id, opts = {})
  data, _status_code, _headers = read_container_enrichment_with_http_info(container_id, opts)
  data
end

#read_container_enrichment_with_http_info(container_id, opts = {}) ⇒ Array<(K8sassetsContainerEnrichmentResponse, Integer, Hash)>

Retrieve container enrichment data

Parameters:

  • container_id (Array<String>) —

    One or more container ids for which to retrieve enrichment info

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Supported filter fields: - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60;

Returns:



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

def read_container_enrichment_with_http_info(container_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_container_enrichment ...'
  end
  # verify the required parameter 'container_id' is set
  if @api_client.config.client_side_validation && container_id.nil?
    fail ArgumentError, "Missing the required parameter 'container_id' when calling KubernetesProtection.read_container_enrichment"
  end
  # resource path
  local_var_path = '/container-security/aggregates/enrichment/containers/entities/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'container_id'] = @api_client.build_collection_param(container_id, :csv)
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?

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

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

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

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

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

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

#read_container_image_detections_count_by_date(opts = {}) ⇒ ModelsAPIFilterResponse

Retrieve count of image assessment detections on running containers over a period of time

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:



2136
2137
2138
2139
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2136

def read_container_image_detections_count_by_date(opts = {})
  data, _status_code, _headers = read_container_image_detections_count_by_date_with_http_info(opts)
  data
end

#read_container_image_detections_count_by_date_with_http_info(opts = {}) ⇒ Array<(ModelsAPIFilterResponse, Integer, Hash)>

Retrieve count of image assessment detections on running containers over a period of time

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:

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

    ModelsAPIFilterResponse data, response status code and response headers



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

def read_container_image_detections_count_by_date_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_container_image_detections_count_by_date ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/containers/image-detections-count-by-date/v1'

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

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

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

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

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

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

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

#read_container_images_by_most_used(opts = {}) ⇒ ModelsAggregateValuesByFieldResponse

Bucket container by image-digest

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:



2194
2195
2196
2197
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2194

def read_container_images_by_most_used(opts = {})
  data, _status_code, _headers = read_container_images_by_most_used_with_http_info(opts)
  data
end

#read_container_images_by_most_used_with_http_info(opts = {}) ⇒ Array<(ModelsAggregateValuesByFieldResponse, Integer, Hash)>

Bucket container by image-digest

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:



2203
2204
2205
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
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2203

def read_container_images_by_most_used_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_container_images_by_most_used ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/images/most-used/v1'

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

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

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

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

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

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

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

#read_container_images_by_state(opts = {}) ⇒ ModelsAPIFilterResponse

Retrieve count of image states running on containers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;cid&#x60;

Returns:



2252
2253
2254
2255
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2252

def read_container_images_by_state(opts = {})
  data, _status_code, _headers = read_container_images_by_state_with_http_info(opts)
  data
end

#read_container_images_by_state_with_http_info(opts = {}) ⇒ Array<(ModelsAPIFilterResponse, Integer, Hash)>

Retrieve count of image states running on containers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;cid&#x60;

Returns:

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

    ModelsAPIFilterResponse data, response status code and response headers



2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
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
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2261

def read_container_images_by_state_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_container_images_by_state ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/containers/images-by-state/v1'

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

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

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

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

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

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

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

#read_container_vulnerabilities_by_severity_count(opts = {}) ⇒ ModelsAggregateValuesByFieldResponse

Retrieve container vulnerabilities by severity counts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Get vulnerabilities count by severity for container using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:



2310
2311
2312
2313
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2310

def read_container_vulnerabilities_by_severity_count(opts = {})
  data, _status_code, _headers = read_container_vulnerabilities_by_severity_count_with_http_info(opts)
  data
end

#read_container_vulnerabilities_by_severity_count_with_http_info(opts = {}) ⇒ Array<(ModelsAggregateValuesByFieldResponse, Integer, Hash)>

Retrieve container vulnerabilities by severity counts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Get vulnerabilities count by severity for container using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:



2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
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
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2319

def read_container_vulnerabilities_by_severity_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_container_vulnerabilities_by_severity_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/containers/vulnerability-count-by-severity/v1'

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

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

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

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

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

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

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

#read_containers_by_date_range_count(opts = {}) ⇒ ModelsAggregateValuesByFieldResponse

Retrieve containers by date range counts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Get container counts using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:



2368
2369
2370
2371
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2368

def read_containers_by_date_range_count(opts = {})
  data, _status_code, _headers = read_containers_by_date_range_count_with_http_info(opts)
  data
end

#read_containers_by_date_range_count_with_http_info(opts = {}) ⇒ Array<(ModelsAggregateValuesByFieldResponse, Integer, Hash)>

Retrieve containers by date range counts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Get container counts using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:



2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2377

def read_containers_by_date_range_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_containers_by_date_range_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/containers/count-by-date/v1'

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

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

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

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

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

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

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

#read_containers_sensor_coverage(opts = {}) ⇒ ModelsAggregateValuesByFieldResponse

Bucket containers by agent type and calculate sensor coverage

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:



2426
2427
2428
2429
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2426

def read_containers_sensor_coverage(opts = {})
  data, _status_code, _headers = read_containers_sensor_coverage_with_http_info(opts)
  data
end

#read_containers_sensor_coverage_with_http_info(opts = {}) ⇒ Array<(ModelsAggregateValuesByFieldResponse, Integer, Hash)>

Bucket containers by agent type and calculate sensor coverage

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:



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
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2435

def read_containers_sensor_coverage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_containers_sensor_coverage ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/containers/sensor-coverage/v1'

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

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

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

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

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

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

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

#read_deployment_combined(opts = {}) ⇒ ModelsDeploymentEntityResponse

Retrieve kubernetes deployments identified by the provided filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes deployments using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;annotations_list&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;deployment_id&#x60; - &#x60;deployment_name&#x60; - &#x60;deployment_status&#x60; - &#x60;first_seen&#x60; - &#x60;kac_agent_id&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;pod_count&#x60; - &#x60;resource_status&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 200. (default to 200)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

Returns:



2487
2488
2489
2490
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2487

def read_deployment_combined(opts = {})
  data, _status_code, _headers = read_deployment_combined_with_http_info(opts)
  data
end

#read_deployment_combined_with_http_info(opts = {}) ⇒ Array<(ModelsDeploymentEntityResponse, Integer, Hash)>

Retrieve kubernetes deployments identified by the provided filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes deployments using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;annotations_list&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;deployment_id&#x60; - &#x60;deployment_name&#x60; - &#x60;deployment_status&#x60; - &#x60;first_seen&#x60; - &#x60;kac_agent_id&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;pod_count&#x60; - &#x60;resource_status&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 200. (default to 200)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

Returns:



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

def read_deployment_combined_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_deployment_combined ...'
  end
  # resource path
  local_var_path = '/container-security/combined/deployments/v1'

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

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

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

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

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

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

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

#read_deployment_count(opts = {}) ⇒ CommonCountResponse

Retrieve deployment counts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes deployments that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;annotations_list&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;deployment_id&#x60; - &#x60;deployment_name&#x60; - &#x60;deployment_status&#x60; - &#x60;first_seen&#x60; - &#x60;kac_agent_id&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;pod_count&#x60; - &#x60;resource_status&#x60;

Returns:



2551
2552
2553
2554
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2551

def read_deployment_count(opts = {})
  data, _status_code, _headers = read_deployment_count_with_http_info(opts)
  data
end

#read_deployment_count_with_http_info(opts = {}) ⇒ Array<(CommonCountResponse, Integer, Hash)>

Retrieve deployment counts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes deployments that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;annotations_list&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;deployment_id&#x60; - &#x60;deployment_name&#x60; - &#x60;deployment_status&#x60; - &#x60;first_seen&#x60; - &#x60;kac_agent_id&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;pod_count&#x60; - &#x60;resource_status&#x60;

Returns:

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

    CommonCountResponse data, response status code and response headers



2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
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
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2560

def read_deployment_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_deployment_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/deployments/count/v1'

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

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

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

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

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

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

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

#read_deployment_enrichment(deployment_id, opts = {}) ⇒ K8sassetsDeploymentEnrichmentResponse

Retrieve deployment enrichment data

Parameters:

  • deployment_id (Array<String>) —

    One or more deployment ids for which to retrieve enrichment info

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Supported filter fields: - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60;

Returns:



2610
2611
2612
2613
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2610

def read_deployment_enrichment(deployment_id, opts = {})
  data, _status_code, _headers = read_deployment_enrichment_with_http_info(deployment_id, opts)
  data
end

#read_deployment_enrichment_with_http_info(deployment_id, opts = {}) ⇒ Array<(K8sassetsDeploymentEnrichmentResponse, Integer, Hash)>

Retrieve deployment enrichment data

Parameters:

  • deployment_id (Array<String>) —

    One or more deployment ids for which to retrieve enrichment info

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Supported filter fields: - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60;

Returns:



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
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2620

def read_deployment_enrichment_with_http_info(deployment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_deployment_enrichment ...'
  end
  # verify the required parameter 'deployment_id' is set
  if @api_client.config.client_side_validation && deployment_id.nil?
    fail ArgumentError, "Missing the required parameter 'deployment_id' when calling KubernetesProtection.read_deployment_enrichment"
  end
  # resource path
  local_var_path = '/container-security/aggregates/enrichment/deployments/entities/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'deployment_id'] = @api_client.build_collection_param(deployment_id, :csv)
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?

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

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

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

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

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

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

#read_deployments_by_date_range_count(opts = {}) ⇒ ModelsAggregateValuesByFieldResponse

Retrieve deployments by date range counts

Parameters:

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

    the optional parameters

Returns:



2673
2674
2675
2676
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2673

def read_deployments_by_date_range_count(opts = {})
  data, _status_code, _headers = read_deployments_by_date_range_count_with_http_info(opts)
  data
end

#read_deployments_by_date_range_count_with_http_info(opts = {}) ⇒ Array<(ModelsAggregateValuesByFieldResponse, Integer, Hash)>

Retrieve deployments by date range counts

Parameters:

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

    the optional parameters

Returns:



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

def read_deployments_by_date_range_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_deployments_by_date_range_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/deployments/count-by-date/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'])

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

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

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

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

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

#read_distinct_container_image_count(opts = {}) ⇒ ModelsAPIFilterResponse

Retrieve count of distinct images running on containers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes containers using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:



2729
2730
2731
2732
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2729

def read_distinct_container_image_count(opts = {})
  data, _status_code, _headers = read_distinct_container_image_count_with_http_info(opts)
  data
end

#read_distinct_container_image_count_with_http_info(opts = {}) ⇒ Array<(ModelsAPIFilterResponse, Integer, Hash)>

Retrieve count of distinct images running on containers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes containers using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:

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

    ModelsAPIFilterResponse data, response status code and response headers



2738
2739
2740
2741
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
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2738

def read_distinct_container_image_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_distinct_container_image_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/images/count-by-distinct/v1'

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

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

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

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

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

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

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

#read_kubernetes_iom_by_date_range(opts = {}) ⇒ K8siomsKubernetesIOMFieldValue

Returns the count of Kubernetes IOMs by the date. by default it’s for 7 days.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter Kubernetes IOMs using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;cid&#x60; - &#x60;created_timestamp&#x60; - &#x60;detect_timestamp&#x60; - &#x60;prevented&#x60; - &#x60;severity&#x60;

Returns:



2787
2788
2789
2790
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2787

def read_kubernetes_iom_by_date_range(opts = {})
  data, _status_code, _headers = read_kubernetes_iom_by_date_range_with_http_info(opts)
  data
end

#read_kubernetes_iom_by_date_range_with_http_info(opts = {}) ⇒ Array<(K8siomsKubernetesIOMFieldValue, Integer, Hash)>

Returns the count of Kubernetes IOMs by the date. by default it&#39;s for 7 days.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter Kubernetes IOMs using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;cid&#x60; - &#x60;created_timestamp&#x60; - &#x60;detect_timestamp&#x60; - &#x60;prevented&#x60; - &#x60;severity&#x60;

Returns:



2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
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
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2796

def read_kubernetes_iom_by_date_range_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_kubernetes_iom_by_date_range ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/kubernetes-ioms/count-by-date/v1'

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

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

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

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

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

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

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

#read_kubernetes_iom_count(opts = {}) ⇒ K8siomsKubernetesIOMCountValue

Returns the total count of Kubernetes IOMs over the past seven days

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter Kubernetes IOMs using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;cid&#x60; - &#x60;created_timestamp&#x60; - &#x60;detect_timestamp&#x60; - &#x60;prevented&#x60; - &#x60;severity&#x60;

Returns:



2845
2846
2847
2848
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2845

def read_kubernetes_iom_count(opts = {})
  data, _status_code, _headers = read_kubernetes_iom_count_with_http_info(opts)
  data
end

#read_kubernetes_iom_count_with_http_info(opts = {}) ⇒ Array<(K8siomsKubernetesIOMCountValue, Integer, Hash)>

Returns the total count of Kubernetes IOMs over the past seven days

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter Kubernetes IOMs using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;cid&#x60; - &#x60;created_timestamp&#x60; - &#x60;detect_timestamp&#x60; - &#x60;prevented&#x60; - &#x60;severity&#x60;

Returns:



2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2854

def read_kubernetes_iom_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_kubernetes_iom_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/kubernetes-ioms/count/v1'

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

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

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

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

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

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

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

#read_kubernetes_iom_entities(opts = {}) ⇒ K8siomsKubernetesIOMEntityResponse

Retrieve Kubernetes IOM entities identified by the provided IDs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Search Kubernetes IOMs by ids - The maximum amount is 100 IDs

Returns:



2903
2904
2905
2906
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2903

def read_kubernetes_iom_entities(opts = {})
  data, _status_code, _headers = read_kubernetes_iom_entities_with_http_info(opts)
  data
end

#read_kubernetes_iom_entities_with_http_info(opts = {}) ⇒ Array<(K8siomsKubernetesIOMEntityResponse, Integer, Hash)>

Retrieve Kubernetes IOM entities identified by the provided IDs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Search Kubernetes IOMs by ids - The maximum amount is 100 IDs

Returns:



2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2912

def read_kubernetes_iom_entities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_kubernetes_iom_entities ...'
  end
  # resource path
  local_var_path = '/container-security/entities/kubernetes-ioms/v1'

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

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

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

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

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

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

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

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

#read_namespace_count(opts = {}) ⇒ CommonCountResponse

Retrieve namespace counts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes namespaces that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;annotations_list&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;first_seen&#x60; - &#x60;kac_agent_id&#x60; - &#x60;last_seen&#x60; - &#x60;namespace_id&#x60; - &#x60;namespace_name&#x60; - &#x60;resource_status&#x60;

Returns:



2961
2962
2963
2964
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2961

def read_namespace_count(opts = {})
  data, _status_code, _headers = read_namespace_count_with_http_info(opts)
  data
end

#read_namespace_count_with_http_info(opts = {}) ⇒ Array<(CommonCountResponse, Integer, Hash)>

Retrieve namespace counts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes namespaces that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;annotations_list&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;first_seen&#x60; - &#x60;kac_agent_id&#x60; - &#x60;last_seen&#x60; - &#x60;namespace_id&#x60; - &#x60;namespace_name&#x60; - &#x60;resource_status&#x60;

Returns:

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

    CommonCountResponse data, response status code and response headers



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
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 2970

def read_namespace_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_namespace_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/namespaces/count/v1'

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

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

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

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

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

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

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

#read_namespaces_by_date_range_count(opts = {}) ⇒ ModelsAggregateValuesByFieldResponse

Retrieve namespaces by date range counts

Parameters:

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

    the optional parameters

Returns:



3018
3019
3020
3021
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3018

def read_namespaces_by_date_range_count(opts = {})
  data, _status_code, _headers = read_namespaces_by_date_range_count_with_http_info(opts)
  data
end

#read_namespaces_by_date_range_count_with_http_info(opts = {}) ⇒ Array<(ModelsAggregateValuesByFieldResponse, Integer, Hash)>

Retrieve namespaces by date range counts

Parameters:

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

    the optional parameters

Returns:



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

def read_namespaces_by_date_range_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_namespaces_by_date_range_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/namespaces/count-by-date/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'])

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

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

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

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

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

#read_node_combined(opts = {}) ⇒ ModelsNodeEntityResponse

Retrieve kubernetes nodes identified by the provided filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes nodes using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;annotations_list&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_count&#x60; - &#x60;container_runtime_version&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;ipv4&#x60; - &#x60;kac_agent_id&#x60; - &#x60;last_seen&#x60; - &#x60;linux_sensor_coverage&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;pod_count&#x60; - &#x60;resource_status&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 200. (default to 200)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

Returns:



3077
3078
3079
3080
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3077

def read_node_combined(opts = {})
  data, _status_code, _headers = read_node_combined_with_http_info(opts)
  data
end

#read_node_combined_with_http_info(opts = {}) ⇒ Array<(ModelsNodeEntityResponse, Integer, Hash)>

Retrieve kubernetes nodes identified by the provided filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes nodes using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;annotations_list&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_count&#x60; - &#x60;container_runtime_version&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;ipv4&#x60; - &#x60;kac_agent_id&#x60; - &#x60;last_seen&#x60; - &#x60;linux_sensor_coverage&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;pod_count&#x60; - &#x60;resource_status&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 200. (default to 200)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

Returns:

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

    ModelsNodeEntityResponse data, response status code and response headers



3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
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
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3089

def read_node_combined_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_node_combined ...'
  end
  # resource path
  local_var_path = '/container-security/combined/nodes/v1'

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

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

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

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

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

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

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

#read_node_count(opts = {}) ⇒ CommonCountResponse

Retrieve node counts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes nodes that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;annotations_list&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_count&#x60; - &#x60;container_runtime_version&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;ipv4&#x60; - &#x60;kac_agent_id&#x60; - &#x60;last_seen&#x60; - &#x60;linux_sensor_coverage&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;pod_count&#x60; - &#x60;resource_status&#x60;

Returns:



3141
3142
3143
3144
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3141

def read_node_count(opts = {})
  data, _status_code, _headers = read_node_count_with_http_info(opts)
  data
end

#read_node_count_with_http_info(opts = {}) ⇒ Array<(CommonCountResponse, Integer, Hash)>

Retrieve node counts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes nodes that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;annotations_list&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_count&#x60; - &#x60;container_runtime_version&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;ipv4&#x60; - &#x60;kac_agent_id&#x60; - &#x60;last_seen&#x60; - &#x60;linux_sensor_coverage&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;pod_count&#x60; - &#x60;resource_status&#x60;

Returns:

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

    CommonCountResponse data, response status code and response headers



3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3150

def read_node_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_node_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/nodes/count/v1'

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

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

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

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

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

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

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

#read_node_enrichment(node_name, opts = {}) ⇒ K8sassetsNodeEnrichmentResponse

Retrieve node enrichment data

Parameters:

  • node_name (Array<String>) —

    One or more node names for which to retrieve enrichment info

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Supported filter fields: - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60;

Returns:



3200
3201
3202
3203
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3200

def read_node_enrichment(node_name, opts = {})
  data, _status_code, _headers = read_node_enrichment_with_http_info(node_name, opts)
  data
end

#read_node_enrichment_with_http_info(node_name, opts = {}) ⇒ Array<(K8sassetsNodeEnrichmentResponse, Integer, Hash)>

Retrieve node enrichment data

Parameters:

  • node_name (Array<String>) —

    One or more node names for which to retrieve enrichment info

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Supported filter fields: - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60;

Returns:



3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3210

def read_node_enrichment_with_http_info(node_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_node_enrichment ...'
  end
  # verify the required parameter 'node_name' is set
  if @api_client.config.client_side_validation && node_name.nil?
    fail ArgumentError, "Missing the required parameter 'node_name' when calling KubernetesProtection.read_node_enrichment"
  end
  # resource path
  local_var_path = '/container-security/aggregates/enrichment/nodes/entities/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'node_name'] = @api_client.build_collection_param(node_name, :csv)
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?

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

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

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

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

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

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

#read_nodes_by_cloud_count(opts = {}) ⇒ ModelsAggregateValuesByFieldResponse

Bucket nodes by cloud providers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes nodes using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;annotations_list&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_count&#x60; - &#x60;container_runtime_version&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;ipv4&#x60; - &#x60;kac_agent_id&#x60; - &#x60;last_seen&#x60; - &#x60;linux_sensor_coverage&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;pod_count&#x60; - &#x60;resource_status&#x60;

Returns:



3264
3265
3266
3267
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3264

def read_nodes_by_cloud_count(opts = {})
  data, _status_code, _headers = read_nodes_by_cloud_count_with_http_info(opts)
  data
end

#read_nodes_by_cloud_count_with_http_info(opts = {}) ⇒ Array<(ModelsAggregateValuesByFieldResponse, Integer, Hash)>

Bucket nodes by cloud providers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes nodes using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;annotations_list&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_count&#x60; - &#x60;container_runtime_version&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;ipv4&#x60; - &#x60;kac_agent_id&#x60; - &#x60;last_seen&#x60; - &#x60;linux_sensor_coverage&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;pod_count&#x60; - &#x60;resource_status&#x60;

Returns:



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
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3273

def read_nodes_by_cloud_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_nodes_by_cloud_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/nodes/count-by-cloud/v1'

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

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

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

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

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

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

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

#read_nodes_by_container_engine_version_count(opts = {}) ⇒ ModelsAggregateValuesByFieldResponse

Bucket nodes by their container engine version

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes nodes using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;annotations_list&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_count&#x60; - &#x60;container_runtime_version&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;ipv4&#x60; - &#x60;kac_agent_id&#x60; - &#x60;last_seen&#x60; - &#x60;linux_sensor_coverage&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;pod_count&#x60; - &#x60;resource_status&#x60;

Returns:



3322
3323
3324
3325
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3322

def read_nodes_by_container_engine_version_count(opts = {})
  data, _status_code, _headers = read_nodes_by_container_engine_version_count_with_http_info(opts)
  data
end

#read_nodes_by_container_engine_version_count_with_http_info(opts = {}) ⇒ Array<(ModelsAggregateValuesByFieldResponse, Integer, Hash)>

Bucket nodes by their container engine version

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes nodes using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;annotations_list&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_count&#x60; - &#x60;container_runtime_version&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;ipv4&#x60; - &#x60;kac_agent_id&#x60; - &#x60;last_seen&#x60; - &#x60;linux_sensor_coverage&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;pod_count&#x60; - &#x60;resource_status&#x60;

Returns:



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
3372
3373
3374
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3331

def read_nodes_by_container_engine_version_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_nodes_by_container_engine_version_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/nodes/count-by-container-engine-version/v1'

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

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

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

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

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

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

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

#read_nodes_by_date_range_count(opts = {}) ⇒ ModelsAggregateValuesByFieldResponse

Retrieve nodes by date range counts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes nodes using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;annotations_list&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_count&#x60; - &#x60;container_runtime_version&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;ipv4&#x60; - &#x60;kac_agent_id&#x60; - &#x60;last_seen&#x60; - &#x60;linux_sensor_coverage&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;pod_count&#x60; - &#x60;resource_status&#x60;

Returns:



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

def read_nodes_by_date_range_count(opts = {})
  data, _status_code, _headers = read_nodes_by_date_range_count_with_http_info(opts)
  data
end

#read_nodes_by_date_range_count_with_http_info(opts = {}) ⇒ Array<(ModelsAggregateValuesByFieldResponse, Integer, Hash)>

Retrieve nodes by date range counts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes nodes using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;annotations_list&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_count&#x60; - &#x60;container_runtime_version&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;ipv4&#x60; - &#x60;kac_agent_id&#x60; - &#x60;last_seen&#x60; - &#x60;linux_sensor_coverage&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;pod_count&#x60; - &#x60;resource_status&#x60;

Returns:



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

def read_nodes_by_date_range_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_nodes_by_date_range_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/nodes/count-by-date/v1'

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

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

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

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

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

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

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

#read_pod_combined(opts = {}) ⇒ ModelsPodEntityResponse

Retrieve kubernetes pods identified by the provided filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes pods using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;annotations_list&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_count&#x60; - &#x60;first_seen&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;owner_id&#x60; - &#x60;owner_type&#x60; - &#x60;pod_external_id&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;resource_status&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 200. (default to 200)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

Returns:



3441
3442
3443
3444
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3441

def read_pod_combined(opts = {})
  data, _status_code, _headers = read_pod_combined_with_http_info(opts)
  data
end

#read_pod_combined_with_http_info(opts = {}) ⇒ Array<(ModelsPodEntityResponse, Integer, Hash)>

Retrieve kubernetes pods identified by the provided filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes pods using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;annotations_list&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_count&#x60; - &#x60;first_seen&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;owner_id&#x60; - &#x60;owner_type&#x60; - &#x60;pod_external_id&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;resource_status&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 200. (default to 200)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

Returns:

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

    ModelsPodEntityResponse data, response status code and response headers



3453
3454
3455
3456
3457
3458
3459
3460
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
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3453

def read_pod_combined_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_pod_combined ...'
  end
  # resource path
  local_var_path = '/container-security/combined/pods/v1'

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

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

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

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

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

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

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

#read_pod_count(opts = {}) ⇒ CommonCountResponse

Retrieve pod counts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes pods that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;annotations_list&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_count&#x60; - &#x60;first_seen&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;owner_id&#x60; - &#x60;owner_type&#x60; - &#x60;pod_external_id&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;resource_status&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60;

Returns:



3505
3506
3507
3508
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3505

def read_pod_count(opts = {})
  data, _status_code, _headers = read_pod_count_with_http_info(opts)
  data
end

#read_pod_count_with_http_info(opts = {}) ⇒ Array<(CommonCountResponse, Integer, Hash)>

Retrieve pod counts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes pods that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;annotations_list&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_count&#x60; - &#x60;first_seen&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;owner_id&#x60; - &#x60;owner_type&#x60; - &#x60;pod_external_id&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;resource_status&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60;

Returns:

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

    CommonCountResponse data, response status code and response headers



3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3514

def read_pod_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_pod_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/pods/count/v1'

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

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

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

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

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

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

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

#read_pod_enrichment(pod_id, opts = {}) ⇒ K8sassetsPodEnrichmentResponse

Retrieve pod enrichment data

Parameters:

  • pod_id (Array<String>) —

    One or more pod ids for which to retrieve enrichment info

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Supported filter fields: - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60;

Returns:



3564
3565
3566
3567
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3564

def read_pod_enrichment(pod_id, opts = {})
  data, _status_code, _headers = read_pod_enrichment_with_http_info(pod_id, opts)
  data
end

#read_pod_enrichment_with_http_info(pod_id, opts = {}) ⇒ Array<(K8sassetsPodEnrichmentResponse, Integer, Hash)>

Retrieve pod enrichment data

Parameters:

  • pod_id (Array<String>) —

    One or more pod ids for which to retrieve enrichment info

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Supported filter fields: - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60;

Returns:



3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3574

def read_pod_enrichment_with_http_info(pod_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_pod_enrichment ...'
  end
  # verify the required parameter 'pod_id' is set
  if @api_client.config.client_side_validation && pod_id.nil?
    fail ArgumentError, "Missing the required parameter 'pod_id' when calling KubernetesProtection.read_pod_enrichment"
  end
  # resource path
  local_var_path = '/container-security/aggregates/enrichment/pods/entities/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pod_id'] = @api_client.build_collection_param(pod_id, :csv)
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?

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

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

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

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

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

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

#read_pods_by_date_range_count(opts = {}) ⇒ ModelsAggregateValuesByFieldResponse

Retrieve pods by date range counts

Parameters:

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

    the optional parameters

Returns:



3627
3628
3629
3630
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3627

def read_pods_by_date_range_count(opts = {})
  data, _status_code, _headers = read_pods_by_date_range_count_with_http_info(opts)
  data
end

#read_pods_by_date_range_count_with_http_info(opts = {}) ⇒ Array<(ModelsAggregateValuesByFieldResponse, Integer, Hash)>

Retrieve pods by date range counts

Parameters:

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

    the optional parameters

Returns:



3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3635

def read_pods_by_date_range_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_pods_by_date_range_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/pods/count-by-date/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'])

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

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

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

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

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

#read_running_container_images(opts = {}) ⇒ ModelsContainerImage

Retrieve images on running containers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve list of images on running containers using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;hosts&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_name&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;running_status&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 200. (default to 200)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

Returns:



3686
3687
3688
3689
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3686

def read_running_container_images(opts = {})
  data, _status_code, _headers = read_running_container_images_with_http_info(opts)
  data
end

#read_running_container_images_with_http_info(opts = {}) ⇒ Array<(ModelsContainerImage, Integer, Hash)>

Retrieve images on running containers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve list of images on running containers using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;hosts&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_name&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;running_status&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 200. (default to 200)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

Returns:

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

    ModelsContainerImage data, response status code and response headers



3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3698

def read_running_container_images_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_running_container_images ...'
  end
  # resource path
  local_var_path = '/container-security/combined/container-images/v1'

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

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

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

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

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

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

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

#read_vulnerable_container_image_count(opts = {}) ⇒ ModelsAPIFilterResponse

Retrieve count of vulnerable images running on containers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:



3750
3751
3752
3753
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3750

def read_vulnerable_container_image_count(opts = {})
  data, _status_code, _headers = read_vulnerable_container_image_count_with_http_info(opts)
  data
end

#read_vulnerable_container_image_count_with_http_info(opts = {}) ⇒ Array<(ModelsAPIFilterResponse, Integer, Hash)>

Retrieve count of vulnerable images running on containers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Retrieve count of Kubernetes containers that match a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;agent_id&#x60; - &#x60;agent_type&#x60; - &#x60;ai_related&#x60; - &#x60;allow_privilege_escalation&#x60; - &#x60;app_name&#x60; - &#x60;cid&#x60; - &#x60;cloud_account_id&#x60; - &#x60;cloud_instance_id&#x60; - &#x60;cloud_name&#x60; - &#x60;cloud_region&#x60; - &#x60;cloud_service&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;container_id&#x60; - &#x60;container_image_id&#x60; - &#x60;container_name&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;first_seen&#x60; - &#x60;image_detection_count&#x60; - &#x60;image_digest&#x60; - &#x60;image_has_been_assessed&#x60; - &#x60;image_id&#x60; - &#x60;image_registry&#x60; - &#x60;image_repository&#x60; - &#x60;image_tag&#x60; - &#x60;image_vulnerability_count&#x60; - &#x60;insecure_mount_source&#x60; - &#x60;insecure_mount_type&#x60; - &#x60;insecure_propagation_mode&#x60; - &#x60;interactive_mode&#x60; - &#x60;ipv4&#x60; - &#x60;ipv6&#x60; - &#x60;kac_agent_id&#x60; - &#x60;labels&#x60; - &#x60;last_seen&#x60; - &#x60;namespace&#x60; - &#x60;node_name&#x60; - &#x60;node_uid&#x60; - &#x60;package_name_version&#x60; - &#x60;pod_id&#x60; - &#x60;pod_name&#x60; - &#x60;port&#x60; - &#x60;privileged&#x60; - &#x60;root_write_access&#x60; - &#x60;run_as_root_group&#x60; - &#x60;run_as_root_user&#x60; - &#x60;running_status&#x60;

Returns:

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

    ModelsAPIFilterResponse data, response status code and response headers



3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3759

def read_vulnerable_container_image_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.read_vulnerable_container_image_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/containers/count-vulnerable-images/v1'

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

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

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

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

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

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

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

#regenerate_api_key(opts = {}) ⇒ K8sregRegenAPIKeyResp

Regenerate API key for docker registry integrations

Parameters:

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

    the optional parameters

Returns:



3807
3808
3809
3810
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3807

def regenerate_api_key(opts = {})
  data, _status_code, _headers = regenerate_api_key_with_http_info(opts)
  data
end

#regenerate_api_key_with_http_info(opts = {}) ⇒ Array<(K8sregRegenAPIKeyResp, Integer, Hash)>

Regenerate API key for docker registry integrations

Parameters:

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

    the optional parameters

Returns:

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

    K8sregRegenAPIKeyResp data, response status code and response headers



3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3815

def regenerate_api_key_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.regenerate_api_key ...'
  end
  # resource path
  local_var_path = '/kubernetes-protection/entities/integration/api-key/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'])

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

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

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

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

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

#search_and_read_kubernetes_iom_entities(opts = {}) ⇒ K8siomsKubernetesIOMEntityResponse

Retrieves a list of Kubernetes IOMs identified by the provided search criteria. Maximum page size: 100. Maximum available Kubernetes IOMs: 10,000

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes IOMs using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;cid&#x60; - &#x60;cis_id&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;containers_impacted_ai_related&#x60; - &#x60;containers_impacted_count&#x60; - &#x60;containers_impacted_ids&#x60; - &#x60;detection_type&#x60; - &#x60;name&#x60; - &#x60;namespace&#x60; - &#x60;prevented&#x60; - &#x60;resource_id&#x60; - &#x60;resource_name&#x60; - &#x60;resource_type&#x60; - &#x60;severity&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 100. (default to 100)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

Returns:



3866
3867
3868
3869
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3866

def search_and_read_kubernetes_iom_entities(opts = {})
  data, _status_code, _headers = search_and_read_kubernetes_iom_entities_with_http_info(opts)
  data
end

#search_and_read_kubernetes_iom_entities_with_http_info(opts = {}) ⇒ Array<(K8siomsKubernetesIOMEntityResponse, Integer, Hash)>

Retrieves a list of Kubernetes IOMs identified by the provided search criteria. Maximum page size: 100. Maximum available Kubernetes IOMs: 10,000

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes IOMs using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;cid&#x60; - &#x60;cis_id&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;containers_impacted_ai_related&#x60; - &#x60;containers_impacted_count&#x60; - &#x60;containers_impacted_ids&#x60; - &#x60;detection_type&#x60; - &#x60;name&#x60; - &#x60;namespace&#x60; - &#x60;prevented&#x60; - &#x60;resource_id&#x60; - &#x60;resource_name&#x60; - &#x60;resource_type&#x60; - &#x60;severity&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 100. (default to 100)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

Returns:



3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3878

def search_and_read_kubernetes_iom_entities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.search_and_read_kubernetes_iom_entities ...'
  end
  # resource path
  local_var_path = '/container-security/combined/kubernetes-ioms/v1'

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

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

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

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

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

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

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

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

#search_kubernetes_ioms(opts = {}) ⇒ CommonGenericEntityResponseString

Search Kubernetes IOMs by the provided search criteria. this endpoint returns a list of Kubernetes IOM UUIDs matching the query

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes IOMs using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;cid&#x60; - &#x60;cis_id&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;containers_impacted_ai_related&#x60; - &#x60;containers_impacted_count&#x60; - &#x60;containers_impacted_ids&#x60; - &#x60;detection_type&#x60; - &#x60;name&#x60; - &#x60;namespace&#x60; - &#x60;prevented&#x60; - &#x60;resource_id&#x60; - &#x60;resource_name&#x60; - &#x60;resource_type&#x60; - &#x60;severity&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 100. (default to 100)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

Returns:



3933
3934
3935
3936
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3933

def search_kubernetes_ioms(opts = {})
  data, _status_code, _headers = search_kubernetes_ioms_with_http_info(opts)
  data
end

#search_kubernetes_ioms_with_http_info(opts = {}) ⇒ Array<(CommonGenericEntityResponseString, Integer, Hash)>

Search Kubernetes IOMs by the provided search criteria. this endpoint returns a list of Kubernetes IOM UUIDs matching the query

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search Kubernetes IOMs using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;cid&#x60; - &#x60;cis_id&#x60; - &#x60;cluster_id&#x60; - &#x60;cluster_name&#x60; - &#x60;containers_impacted_ai_related&#x60; - &#x60;containers_impacted_count&#x60; - &#x60;containers_impacted_ids&#x60; - &#x60;detection_type&#x60; - &#x60;name&#x60; - &#x60;namespace&#x60; - &#x60;prevented&#x60; - &#x60;resource_id&#x60; - &#x60;resource_name&#x60; - &#x60;resource_type&#x60; - &#x60;severity&#x60;

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. Maximum limit: 100. (default to 100)

  • :offset (Integer) —

    The offset from where to begin. Maximum offset &#x3D; 10000 - limit.

Returns:



3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3945

def search_kubernetes_ioms_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.search_kubernetes_ioms ...'
  end
  # resource path
  local_var_path = '/container-security/queries/kubernetes-ioms/v1'

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

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

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

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

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

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

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

#trigger_scan(scan_type, opts = {}) ⇒ MsaBaseEntitiesResponse

Triggers a dry run or a full scan of a customer’s kubernetes footprint

Parameters:

  • scan_type (String) —

    Scan Type to do

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

    the optional parameters

Returns:



3997
3998
3999
4000
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 3997

def trigger_scan(scan_type, opts = {})
  data, _status_code, _headers = trigger_scan_with_http_info(scan_type, opts)
  data
end

#trigger_scan_with_http_info(scan_type, opts = {}) ⇒ Array<(MsaBaseEntitiesResponse, Integer, Hash)>

Triggers a dry run or a full scan of a customer&#39;s kubernetes footprint

Parameters:

  • scan_type (String) —

    Scan Type to do

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

    the optional parameters

Returns:

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

    MsaBaseEntitiesResponse data, response status code and response headers



4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 4006

def trigger_scan_with_http_info(scan_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.trigger_scan ...'
  end
  # verify the required parameter 'scan_type' is set
  if @api_client.config.client_side_validation && scan_type.nil?
    fail ArgumentError, "Missing the required parameter 'scan_type' when calling KubernetesProtection.trigger_scan"
  end
  # verify enum value
  allowable_values = ["cluster-refresh", "dry-run", "full"]
  if @api_client.config.client_side_validation && !allowable_values.include?(scan_type)
    fail ArgumentError, "invalid value for \"scan_type\", must be one of #{allowable_values}"
  end
  pattern = Regexp.new(/^(dry-run|full|cluster-refresh)$/)
  if @api_client.config.client_side_validation && scan_type !~ pattern
    fail ArgumentError, "invalid value for 'scan_type' when calling KubernetesProtection.trigger_scan, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/kubernetes-protection/entities/scan/trigger/v1'

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

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

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

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

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

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

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

#update_aws_account(ids, opts = {}) ⇒ MsaBaseEntitiesResponse

Updates the AWS account per the query parameters provided

Parameters:

  • ids (Array<String>) —

    AWS Account ID

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

    the optional parameters

Options Hash (opts):

  • :region (String) —

    Default Region for Account Automation

Returns:



4070
4071
4072
4073
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 4070

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

#update_aws_account_with_http_info(ids, opts = {}) ⇒ Array<(MsaBaseEntitiesResponse, Integer, Hash)>

Updates the AWS account per the query parameters provided

Parameters:

  • ids (Array<String>) —

    AWS Account ID

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

    the optional parameters

Options Hash (opts):

  • :region (String) —

    Default Region for Account Automation

Returns:

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

    MsaBaseEntitiesResponse data, response status code and response headers



4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
 
# File 'lib/crimson-falcon/api/kubernetes_protection.rb', line 4080

def (ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KubernetesProtection.update_aws_account ...'
  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 KubernetesProtection.update_aws_account"
  end
  pattern = Regexp.new(/^[a-z\d-]+$/)
  if @api_client.config.client_side_validation && !opts[:'region'].nil? && opts[:'region'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"region\"]' when calling KubernetesProtection.update_aws_account, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/kubernetes-protection/entities/accounts/aws/v1'

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

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

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