Class: Falcon::ContainerImageCompliance

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContainerImageCompliance

Returns a new instance of ContainerImageCompliance.



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

def api_client
  @api_client
end

Instance Method Details

#ext_aggregate_cluster_assessments(opts = {}) ⇒ DomainAggregateClusterAssessmentsResponse

get the assessments for each cluster

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: cloud_info.cloud_account_id: Cloud account ID cloud_info.namespace: Kubernetes namespace compliance_finding.framework: Compliance finding framework (available values: CIS) cid: Customer ID cloud_info.cloud_region: Cloud region cloud_info.cluster_name: Kubernetes cluster name cloud_info.cloud_provider: Cloud provider

Returns:



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

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

#ext_aggregate_cluster_assessments_with_http_info(opts = {}) ⇒ Array<(DomainAggregateClusterAssessmentsResponse, Integer, Hash)>

get the assessments for each cluster

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: cloud_info.cloud_account_id: Cloud account ID cloud_info.namespace: Kubernetes namespace compliance_finding.framework: Compliance finding framework (available values: CIS) cid: Customer ID cloud_info.cloud_region: Cloud region cloud_info.cluster_name: Kubernetes cluster name cloud_info.cloud_provider: Cloud provider

Returns:



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

def ext_aggregate_cluster_assessments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImageCompliance.ext_aggregate_cluster_assessments ...'
  end
  # resource path
  local_var_path = '/container-compliance/aggregates/compliance-by-clusters/v2'

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

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

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

#ext_aggregate_failed_containers_by_rules_path(opts = {}) ⇒ DomainAggregateFailedAssetsByRulesResponse

get the containers grouped into rules on which they failed

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: cloud_info.cloud_region: Cloud region cloud_info.cloud_account_id: Cloud account ID image_repository: Image repository image_id: Image ID compliance_finding.name: Compliance finding Name cloud_info.cluster_name: Kubernetes cluster name image_registry: Image registry image_digest: Image digest (sha256 digest) cloud_info.cloud_provider: Cloud provider compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cid: Customer ID image_tag: Image tag cloud_info.namespace: Kubernetes namespace compliance_finding.id: Compliance finding ID compliance_finding.framework: Compliance finding framework (available values: CIS)

Returns:



100
101
102
103
 
# File 'lib/crimson-falcon/api/container_image_compliance.rb', line 100

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

#ext_aggregate_failed_containers_by_rules_path_with_http_info(opts = {}) ⇒ Array<(DomainAggregateFailedAssetsByRulesResponse, Integer, Hash)>

get the containers grouped into rules on which they failed

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: cloud_info.cloud_region: Cloud region cloud_info.cloud_account_id: Cloud account ID image_repository: Image repository image_id: Image ID compliance_finding.name: Compliance finding Name cloud_info.cluster_name: Kubernetes cluster name image_registry: Image registry image_digest: Image digest (sha256 digest) cloud_info.cloud_provider: Cloud provider compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cid: Customer ID image_tag: Image tag cloud_info.namespace: Kubernetes namespace compliance_finding.id: Compliance finding ID compliance_finding.framework: Compliance finding framework (available values: CIS)

Returns:



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

def ext_aggregate_failed_containers_by_rules_path_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImageCompliance.ext_aggregate_failed_containers_by_rules_path ...'
  end
  # resource path
  local_var_path = '/container-compliance/aggregates/failed-containers-by-rules/v2'

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

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

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

#ext_aggregate_failed_containers_count_by_severity(opts = {}) ⇒ DomainAggregateFailedAssetCountBySeverityResponse

get the failed containers count grouped into severity levels

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: compliance_finding.name: Compliance finding Name compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) image_tag: Image tag cloud_info.cluster_name: Kubernetes cluster name cid: Customer ID image_repository: Image repository cloud_info.namespace: Kubernetes namespace cloud_info.cloud_region: Cloud region image_registry: Image registry cloud_info.cloud_account_id: Cloud account ID compliance_finding.id: Compliance finding ID compliance_finding.framework: Compliance finding framework (available values: CIS) image_id: Image ID image_digest: Image digest (sha256 digest) cloud_info.cloud_provider: Cloud provider

Returns:



158
159
160
161
 
# File 'lib/crimson-falcon/api/container_image_compliance.rb', line 158

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

#ext_aggregate_failed_containers_count_by_severity_with_http_info(opts = {}) ⇒ Array<(DomainAggregateFailedAssetCountBySeverityResponse, Integer, Hash)>

get the failed containers count grouped into severity levels

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: compliance_finding.name: Compliance finding Name compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) image_tag: Image tag cloud_info.cluster_name: Kubernetes cluster name cid: Customer ID image_repository: Image repository cloud_info.namespace: Kubernetes namespace cloud_info.cloud_region: Cloud region image_registry: Image registry cloud_info.cloud_account_id: Cloud account ID compliance_finding.id: Compliance finding ID compliance_finding.framework: Compliance finding framework (available values: CIS) image_id: Image ID image_digest: Image digest (sha256 digest) cloud_info.cloud_provider: Cloud provider

Returns:



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/crimson-falcon/api/container_image_compliance.rb', line 167

def ext_aggregate_failed_containers_count_by_severity_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImageCompliance.ext_aggregate_failed_containers_count_by_severity ...'
  end
  # resource path
  local_var_path = '/container-compliance/aggregates/failed-containers-count-by-severity/v2'

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

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

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

#ext_aggregate_failed_images_by_rules_path(opts = {}) ⇒ DomainAggregateFailedAssetsByRulesResponse

get the images grouped into rules on which they failed

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: cloud_info.cluster_name: Kubernetes cluster name cid: Customer ID image_registry: Image registry image_repository: Image repository cloud_info.namespace: Kubernetes namespace compliance_finding.framework: Compliance finding framework (available values: CIS) image_digest: Image digest (sha256 digest) compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cloud_info.cloud_region: Cloud region cloud_info.cloud_account_id: Cloud account ID image_id: Image ID cloud_info.cloud_provider: Cloud provider image_tag: Image tag compliance_finding.id: Compliance finding ID compliance_finding.name: Compliance finding Name

Returns:



216
217
218
219
 
# File 'lib/crimson-falcon/api/container_image_compliance.rb', line 216

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

#ext_aggregate_failed_images_by_rules_path_with_http_info(opts = {}) ⇒ Array<(DomainAggregateFailedAssetsByRulesResponse, Integer, Hash)>

get the images grouped into rules on which they failed

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: cloud_info.cluster_name: Kubernetes cluster name cid: Customer ID image_registry: Image registry image_repository: Image repository cloud_info.namespace: Kubernetes namespace compliance_finding.framework: Compliance finding framework (available values: CIS) image_digest: Image digest (sha256 digest) compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cloud_info.cloud_region: Cloud region cloud_info.cloud_account_id: Cloud account ID image_id: Image ID cloud_info.cloud_provider: Cloud provider image_tag: Image tag compliance_finding.id: Compliance finding ID compliance_finding.name: Compliance finding Name

Returns:



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/crimson-falcon/api/container_image_compliance.rb', line 225

def ext_aggregate_failed_images_by_rules_path_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImageCompliance.ext_aggregate_failed_images_by_rules_path ...'
  end
  # resource path
  local_var_path = '/container-compliance/aggregates/failed-images-by-rules/v2'

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

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

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

#ext_aggregate_failed_images_count_by_severity(opts = {}) ⇒ DomainAggregateFailedAssetCountBySeverityResponse

get the failed images count grouped into severity levels

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: compliance_finding.id: Compliance finding ID cloud_info.cloud_provider: Cloud provider cloud_info.namespace: Kubernetes namespace compliance_finding.framework: Compliance finding framework (available values: CIS) image_id: Image ID compliance_finding.name: Compliance finding Name cloud_info.cloud_region: Cloud region image_tag: Image tag cloud_info.cloud_account_id: Cloud account ID image_digest: Image digest (sha256 digest) compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cloud_info.cluster_name: Kubernetes cluster name cid: Customer ID image_registry: Image registry image_repository: Image repository

Returns:



274
275
276
277
 
# File 'lib/crimson-falcon/api/container_image_compliance.rb', line 274

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

#ext_aggregate_failed_images_count_by_severity_with_http_info(opts = {}) ⇒ Array<(DomainAggregateFailedAssetCountBySeverityResponse, Integer, Hash)>

get the failed images count grouped into severity levels

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: compliance_finding.id: Compliance finding ID cloud_info.cloud_provider: Cloud provider cloud_info.namespace: Kubernetes namespace compliance_finding.framework: Compliance finding framework (available values: CIS) image_id: Image ID compliance_finding.name: Compliance finding Name cloud_info.cloud_region: Cloud region image_tag: Image tag cloud_info.cloud_account_id: Cloud account ID image_digest: Image digest (sha256 digest) compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cloud_info.cluster_name: Kubernetes cluster name cid: Customer ID image_registry: Image registry image_repository: Image repository

Returns:



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/crimson-falcon/api/container_image_compliance.rb', line 283

def ext_aggregate_failed_images_count_by_severity_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImageCompliance.ext_aggregate_failed_images_count_by_severity ...'
  end
  # resource path
  local_var_path = '/container-compliance/aggregates/failed-images-count-by-severity/v2'

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

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

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

#ext_aggregate_failed_rules_by_clusters(opts = {}) ⇒ DomainAggregateFailedRulesByClustersResponse

get the failed rules for each cluster grouped into severity levels

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: cloud_info.cloud_account_id: Cloud account ID image_repository: Image repository image_digest: Image digest (sha256 digest) asset_type: asset type (container, image) compliance_finding.id: Compliance finding ID compliance_finding.framework: Compliance finding framework (available values: CIS) image_id: Image ID compliance_finding.name: Compliance finding Name cloud_info.cloud_provider: Cloud provider compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cid: Customer ID image_registry: Image registry image_tag: Image tag cloud_info.cloud_region: Cloud region cloud_info.cluster_name: Kubernetes cluster name

Returns:



332
333
334
335
 
# File 'lib/crimson-falcon/api/container_image_compliance.rb', line 332

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

#ext_aggregate_failed_rules_by_clusters_with_http_info(opts = {}) ⇒ Array<(DomainAggregateFailedRulesByClustersResponse, Integer, Hash)>

get the failed rules for each cluster grouped into severity levels

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: cloud_info.cloud_account_id: Cloud account ID image_repository: Image repository image_digest: Image digest (sha256 digest) asset_type: asset type (container, image) compliance_finding.id: Compliance finding ID compliance_finding.framework: Compliance finding framework (available values: CIS) image_id: Image ID compliance_finding.name: Compliance finding Name cloud_info.cloud_provider: Cloud provider compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cid: Customer ID image_registry: Image registry image_tag: Image tag cloud_info.cloud_region: Cloud region cloud_info.cluster_name: Kubernetes cluster name

Returns:



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/crimson-falcon/api/container_image_compliance.rb', line 341

def ext_aggregate_failed_rules_by_clusters_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImageCompliance.ext_aggregate_failed_rules_by_clusters ...'
  end
  # resource path
  local_var_path = '/container-compliance/aggregates/failed-rules-by-clusters/v2'

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

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

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

#ext_aggregate_failed_rules_by_images(opts = {}) ⇒ DomainAggregateFailedRulesByImagesResponse

get images with failed rules, rule count grouped by severity for each image

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: image_registry: Image registry image_tag: Image tag compliance_finding.id: Compliance finding ID cloud_info.cloud_provider: Cloud provider compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cloud_info.cloud_region: Cloud region cloud_info.namespace: Kubernetes namespace asset_type: asset type (container, image) image_repository: Image repository compliance_finding.framework: Compliance finding framework (available values: CIS) image_id: Image ID image_digest: Image digest (sha256 digest) compliance_finding.name: Compliance finding Name cloud_info.cluster_name: Kubernetes cluster name cid: Customer ID cloud_info.cloud_account_id: Cloud account ID

Returns:



390
391
392
393
 
# File 'lib/crimson-falcon/api/container_image_compliance.rb', line 390

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

#ext_aggregate_failed_rules_by_images_with_http_info(opts = {}) ⇒ Array<(DomainAggregateFailedRulesByImagesResponse, Integer, Hash)>

get images with failed rules, rule count grouped by severity for each image

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: image_registry: Image registry image_tag: Image tag compliance_finding.id: Compliance finding ID cloud_info.cloud_provider: Cloud provider compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cloud_info.cloud_region: Cloud region cloud_info.namespace: Kubernetes namespace asset_type: asset type (container, image) image_repository: Image repository compliance_finding.framework: Compliance finding framework (available values: CIS) image_id: Image ID image_digest: Image digest (sha256 digest) compliance_finding.name: Compliance finding Name cloud_info.cluster_name: Kubernetes cluster name cid: Customer ID cloud_info.cloud_account_id: Cloud account ID

Returns:



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

def ext_aggregate_failed_rules_by_images_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImageCompliance.ext_aggregate_failed_rules_by_images ...'
  end
  # resource path
  local_var_path = '/container-compliance/aggregates/failed-rules-by-images/v2'

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

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

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

#ext_aggregate_failed_rules_count_by_severity(opts = {}) ⇒ DomainAggregateFailedRulesCountBySeverityResponse

get the failed rules count grouped into severity levels

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: cid: Customer ID compliance_finding.framework: Compliance finding framework (available values: CIS) image_id: Image ID compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cloud_info.cloud_region: Cloud region cloud_info.cloud_account_id: Cloud account ID asset_type: asset type (container, image) image_repository: Image repository cloud_info.cloud_provider: Cloud provider cloud_info.cluster_name: Kubernetes cluster name image_registry: Image registry image_tag: Image tag compliance_finding.id: Compliance finding ID image_digest: Image digest (sha256 digest) compliance_finding.name: Compliance finding Name

Returns:



448
449
450
451
 
# File 'lib/crimson-falcon/api/container_image_compliance.rb', line 448

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

#ext_aggregate_failed_rules_count_by_severity_with_http_info(opts = {}) ⇒ Array<(DomainAggregateFailedRulesCountBySeverityResponse, Integer, Hash)>

get the failed rules count grouped into severity levels

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: cid: Customer ID compliance_finding.framework: Compliance finding framework (available values: CIS) image_id: Image ID compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cloud_info.cloud_region: Cloud region cloud_info.cloud_account_id: Cloud account ID asset_type: asset type (container, image) image_repository: Image repository cloud_info.cloud_provider: Cloud provider cloud_info.cluster_name: Kubernetes cluster name image_registry: Image registry image_tag: Image tag compliance_finding.id: Compliance finding ID image_digest: Image digest (sha256 digest) compliance_finding.name: Compliance finding Name

Returns:



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

def ext_aggregate_failed_rules_count_by_severity_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImageCompliance.ext_aggregate_failed_rules_count_by_severity ...'
  end
  # resource path
  local_var_path = '/container-compliance/aggregates/failed-rules-count-by-severity/v2'

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

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

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

#ext_aggregate_image_assessments(opts = {}) ⇒ DomainAggregateImageAssessmentsResponse

get the assessments for each image

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: cloud_info.cloud_region: Cloud region cloud_info.cluster_name: Kubernetes cluster name asset_type: asset type (container, image) image_repository: Image repository cloud_info.namespace: Kubernetes namespace compliance_finding.framework: Compliance finding framework (available values: CIS) image_registry: Image registry image_tag: Image tag image_id: Image ID compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cid: Customer ID cloud_info.cloud_account_id: Cloud account ID compliance_finding.id: Compliance finding ID image_digest: Image digest (sha256 digest) cloud_info.cloud_provider: Cloud provider compliance_finding.name: Compliance finding Name

  • :after (String) —

    &#39;after&#39; value from the last response. Keep it empty for the first request.

  • :limit (String) —

    number of images to return in the response after &#39;after&#39; key. Keep it empty for the default number of 10000

Returns:



508
509
510
511
 
# File 'lib/crimson-falcon/api/container_image_compliance.rb', line 508

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

#ext_aggregate_image_assessments_with_http_info(opts = {}) ⇒ Array<(DomainAggregateImageAssessmentsResponse, Integer, Hash)>

get the assessments for each image

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: cloud_info.cloud_region: Cloud region cloud_info.cluster_name: Kubernetes cluster name asset_type: asset type (container, image) image_repository: Image repository cloud_info.namespace: Kubernetes namespace compliance_finding.framework: Compliance finding framework (available values: CIS) image_registry: Image registry image_tag: Image tag image_id: Image ID compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cid: Customer ID cloud_info.cloud_account_id: Cloud account ID compliance_finding.id: Compliance finding ID image_digest: Image digest (sha256 digest) cloud_info.cloud_provider: Cloud provider compliance_finding.name: Compliance finding Name

  • :after (String) —

    &#39;after&#39; value from the last response. Keep it empty for the first request.

  • :limit (String) —

    number of images to return in the response after &#39;after&#39; key. Keep it empty for the default number of 10000

Returns:



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/crimson-falcon/api/container_image_compliance.rb', line 519

def ext_aggregate_image_assessments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImageCompliance.ext_aggregate_image_assessments ...'
  end
  # resource path
  local_var_path = '/container-compliance/aggregates/compliance-by-images/v2'

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

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

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

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

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

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

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

#ext_aggregate_rules_assessments(opts = {}) ⇒ DomainAggregateRulesAssessmentsResponse

get the assessments for each rule

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: image_tag: Image tag cloud_info.cloud_account_id: Cloud account ID image_id: Image ID compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cid: Customer ID image_registry: Image registry compliance_finding.id: Compliance finding ID image_digest: Image digest (sha256 digest) cloud_info.cloud_region: Cloud region cloud_info.cluster_name: Kubernetes cluster name image_repository: Image repository compliance_finding.framework: Compliance finding framework (available values: CIS) cloud_info.cloud_provider: Cloud provider compliance_finding.name: Compliance finding Name

Returns:



570
571
572
573
 
# File 'lib/crimson-falcon/api/container_image_compliance.rb', line 570

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

#ext_aggregate_rules_assessments_with_http_info(opts = {}) ⇒ Array<(DomainAggregateRulesAssessmentsResponse, Integer, Hash)>

get the assessments for each rule

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: image_tag: Image tag cloud_info.cloud_account_id: Cloud account ID image_id: Image ID compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cid: Customer ID image_registry: Image registry compliance_finding.id: Compliance finding ID image_digest: Image digest (sha256 digest) cloud_info.cloud_region: Cloud region cloud_info.cluster_name: Kubernetes cluster name image_repository: Image repository compliance_finding.framework: Compliance finding framework (available values: CIS) cloud_info.cloud_provider: Cloud provider compliance_finding.name: Compliance finding Name

Returns:



579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'lib/crimson-falcon/api/container_image_compliance.rb', line 579

def ext_aggregate_rules_assessments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImageCompliance.ext_aggregate_rules_assessments ...'
  end
  # resource path
  local_var_path = '/container-compliance/aggregates/compliance-by-rules/v2'

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

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

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

#ext_aggregate_rules_by_status(opts = {}) ⇒ DomainAggregateRulesByStatusResponse

get the rules grouped by their statuses

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: cloud_info.cloud_provider: Cloud provider cloud_info.cloud_account_id: Cloud account ID asset_type: asset type (container, image) image_id: Image ID container_name: Container name compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cid: Customer ID image_repository: Image repository container_id: Container ID image_digest: Image digest (sha256 digest) cloud_info.cluster_name: Kubernetes cluster name image_registry: Image registry compliance_finding.name: Compliance finding Name cloud_info.cloud_region: Cloud region image_tag: Image tag compliance_finding.id: Compliance finding ID compliance_finding.framework: Compliance finding framework (available values: CIS)

Returns:



628
629
630
631
 
# File 'lib/crimson-falcon/api/container_image_compliance.rb', line 628

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

#ext_aggregate_rules_by_status_with_http_info(opts = {}) ⇒ Array<(DomainAggregateRulesByStatusResponse, Integer, Hash)>

get the rules grouped by their statuses

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter results using a query in Falcon Query Language (FQL). Supported Filters: cloud_info.cloud_provider: Cloud provider cloud_info.cloud_account_id: Cloud account ID asset_type: asset type (container, image) image_id: Image ID container_name: Container name compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cid: Customer ID image_repository: Image repository container_id: Container ID image_digest: Image digest (sha256 digest) cloud_info.cluster_name: Kubernetes cluster name image_registry: Image registry compliance_finding.name: Compliance finding Name cloud_info.cloud_region: Cloud region image_tag: Image tag compliance_finding.id: Compliance finding ID compliance_finding.framework: Compliance finding framework (available values: CIS)

Returns:



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

def ext_aggregate_rules_by_status_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImageCompliance.ext_aggregate_rules_by_status ...'
  end
  # resource path
  local_var_path = '/container-compliance/aggregates/rules-by-status/v2'

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

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

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

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