Class: Falcon::ContainerImagesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContainerImagesApi

Returns a new instance of ContainerImagesApi.



36
37
38
 
# File 'lib/crimson-falcon/api/container_images_api.rb', line 36

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/crimson-falcon/api/container_images_api.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#aggregate_image_assessment_history(opts = {}) ⇒ ImagesApiImageAssessmentHistory

Image assessment history

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter using a query in Falcon Query Language (FQL). Supported filters: cid,registry,repository

Returns:



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

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

#aggregate_image_assessment_history_with_http_info(opts = {}) ⇒ Array<(ImagesApiImageAssessmentHistory, Integer, Hash)>

Image assessment history

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter using a query in Falcon Query Language (FQL). Supported filters: cid,registry,repository

Returns:



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

def aggregate_image_assessment_history_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImagesApi.aggregate_image_assessment_history ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/images/assessment-history/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] || 'ImagesApiImageAssessmentHistory'

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

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

#aggregate_image_count(opts = {}) ⇒ ImagesApiImageCount

Aggregate count of images

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filters: arch,base_os,cid,container_id,container_running_status,cps_rating,crowdstrike_user,cve_id,detection_count,detection_name,detection_severity,first_seen,image_digest,image_id,layer_digest,package_name_version,registry,repository,tag,vulnerability_count,vulnerability_severity

Returns:



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

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

#aggregate_image_count_by_base_os(opts = {}) ⇒ ImagesApiImageCountByBaseOS

Aggregate count of images grouped by Base OS distribution

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filters: arch,base_os,cid,registry,repository,tag

Returns:



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

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

#aggregate_image_count_by_base_os_with_http_info(opts = {}) ⇒ Array<(ImagesApiImageCountByBaseOS, Integer, Hash)>

Aggregate count of images grouped by Base OS distribution

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filters: arch,base_os,cid,registry,repository,tag

Returns:

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

    ImagesApiImageCountByBaseOS data, response status code and response headers



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

def aggregate_image_count_by_base_os_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImagesApi.aggregate_image_count_by_base_os ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/images/count-by-os-distribution/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] || 'ImagesApiImageCountByBaseOS'

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

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

#aggregate_image_count_by_state(opts = {}) ⇒ ImagesApiImageCountByState

Aggregate count of images grouped by state

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filters: cid,last_seen,registry,repository

Returns:



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

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

#aggregate_image_count_by_state_with_http_info(opts = {}) ⇒ Array<(ImagesApiImageCountByState, Integer, Hash)>

Aggregate count of images grouped by state

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filters: cid,last_seen,registry,repository

Returns:

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

    ImagesApiImageCountByState data, response status code and response headers



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

def aggregate_image_count_by_state_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImagesApi.aggregate_image_count_by_state ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/images/count-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] || 'ImagesApiImageCountByState'

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

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

#aggregate_image_count_with_http_info(opts = {}) ⇒ Array<(ImagesApiImageCount, Integer, Hash)>

Aggregate count of images

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filters: arch,base_os,cid,container_id,container_running_status,cps_rating,crowdstrike_user,cve_id,detection_count,detection_name,detection_severity,first_seen,image_digest,image_id,layer_digest,package_name_version,registry,repository,tag,vulnerability_count,vulnerability_severity

Returns:

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

    ImagesApiImageCount data, response status code and response headers



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

def aggregate_image_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImagesApi.aggregate_image_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/images/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] || 'ImagesApiImageCount'

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

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

#combined_image_by_vulnerability_count(opts = {}) ⇒ ImagesApiImageByVulnerabilityCount

Retrieve top x images with the most vulnerabilities

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filters: arch,base_os,cid,registry,repository,tag

  • :limit (Integer) —

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

  • :offset (Integer) —

    This is not used in the backend but is added here for compatibility purposes as some clients expects this i.e UI widgets.

Returns:



277
278
279
280
 
# File 'lib/crimson-falcon/api/container_images_api.rb', line 277

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

#combined_image_by_vulnerability_count_with_http_info(opts = {}) ⇒ Array<(ImagesApiImageByVulnerabilityCount, Integer, Hash)>

Retrieve top x images with the most vulnerabilities

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filters: arch,base_os,cid,registry,repository,tag

  • :limit (Integer) —

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

  • :offset (Integer) —

    This is not used in the backend but is added here for compatibility purposes as some clients expects this i.e UI widgets.

Returns:



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
327
328
329
330
331
332
333
 
# File 'lib/crimson-falcon/api/container_images_api.rb', line 288

def combined_image_by_vulnerability_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImagesApi.combined_image_by_vulnerability_count ...'
  end
  # resource path
  local_var_path = '/container-security/combined/images/by-vulnerability-count/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].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] || 'ImagesApiImageByVulnerabilityCount'

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

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

#combined_image_detail(opts = {}) ⇒ ImagesApiCustomerAndImage

Retrieve image entities identified by the provided filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filters: registry,repository,tag

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

    include image config, default is false

  • :limit (Integer) —

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

  • :offset (Integer) —

    The offset from where to begin.

  • :sort (String) —

    The fields to sort the records on.

Returns:



343
344
345
346
 
# File 'lib/crimson-falcon/api/container_images_api.rb', line 343

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

#combined_image_detail_with_http_info(opts = {}) ⇒ Array<(ImagesApiCustomerAndImage, Integer, Hash)>

Retrieve image entities identified by the provided filter criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filters: registry,repository,tag

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

    include image config, default is false

  • :limit (Integer) —

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

  • :offset (Integer) —

    The offset from where to begin.

  • :sort (String) —

    The fields to sort the records on.

Returns:

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

    ImagesApiCustomerAndImage data, response status code and response headers



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
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/crimson-falcon/api/container_images_api.rb', line 356

def combined_image_detail_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImagesApi.combined_image_detail ...'
  end
  # resource path
  local_var_path = '/container-security/combined/images/detail/v1'

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

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

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

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

#combined_image_issues_summary(cid, registry, repository, tag, opts = {}) ⇒ ImagesApiImageIssuesSummary

Retrieve image issues summary such as Image detections, Runtime detections, Policies, vulnerabilities

Parameters:

  • cid (String) —

    CID

  • registry (String) —

    registry name

  • repository (String) —

    repository name

  • tag (String) —

    tag name

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

    the optional parameters

Returns:



412
413
414
415
 
# File 'lib/crimson-falcon/api/container_images_api.rb', line 412

def combined_image_issues_summary(cid, registry, repository, tag, opts = {})
  data, _status_code, _headers = combined_image_issues_summary_with_http_info(cid, registry, repository, tag, opts)
  data
end

#combined_image_issues_summary_with_http_info(cid, registry, repository, tag, opts = {}) ⇒ Array<(ImagesApiImageIssuesSummary, Integer, Hash)>

Retrieve image issues summary such as Image detections, Runtime detections, Policies, vulnerabilities

Parameters:

  • cid (String) —

    CID

  • registry (String) —

    registry name

  • repository (String) —

    repository name

  • tag (String) —

    tag name

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

    the optional parameters

Returns:

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

    ImagesApiImageIssuesSummary data, response status code and response headers



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
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
 
# File 'lib/crimson-falcon/api/container_images_api.rb', line 424

def combined_image_issues_summary_with_http_info(cid, registry, repository, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImagesApi.combined_image_issues_summary ...'
  end
  # verify the required parameter 'cid' is set
  if @api_client.config.client_side_validation && cid.nil?
    fail ArgumentError, "Missing the required parameter 'cid' when calling ContainerImagesApi.combined_image_issues_summary"
  end
  # verify the required parameter 'registry' is set
  if @api_client.config.client_side_validation && registry.nil?
    fail ArgumentError, "Missing the required parameter 'registry' when calling ContainerImagesApi.combined_image_issues_summary"
  end
  # verify the required parameter 'repository' is set
  if @api_client.config.client_side_validation && repository.nil?
    fail ArgumentError, "Missing the required parameter 'repository' when calling ContainerImagesApi.combined_image_issues_summary"
  end
  # verify the required parameter 'tag' is set
  if @api_client.config.client_side_validation && tag.nil?
    fail ArgumentError, "Missing the required parameter 'tag' when calling ContainerImagesApi.combined_image_issues_summary"
  end
  # resource path
  local_var_path = '/container-security/combined/images/issues-summary/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cid'] = cid
  query_params[:'registry'] = registry
  query_params[:'repository'] = repository
  query_params[:'tag'] = tag

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

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

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

#combined_image_vulnerability_summary(cid, registry, repository, tag, opts = {}) ⇒ ImagesApiImageVulnerabilitiesSummary

aggregates information about vulnerabilities for an image

Parameters:

  • cid (String) —

    CID

  • registry (String) —

    registry name

  • repository (String) —

    repository name

  • tag (String) —

    tag name

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

    the optional parameters

Returns:



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

def combined_image_vulnerability_summary(cid, registry, repository, tag, opts = {})
  data, _status_code, _headers = combined_image_vulnerability_summary_with_http_info(cid, registry, repository, tag, opts)
  data
end

#combined_image_vulnerability_summary_with_http_info(cid, registry, repository, tag, opts = {}) ⇒ Array<(ImagesApiImageVulnerabilitiesSummary, Integer, Hash)>

aggregates information about vulnerabilities for an image

Parameters:

  • cid (String) —

    CID

  • registry (String) —

    registry name

  • repository (String) —

    repository name

  • tag (String) —

    tag name

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

    the optional parameters

Returns:



507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/crimson-falcon/api/container_images_api.rb', line 507

def combined_image_vulnerability_summary_with_http_info(cid, registry, repository, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImagesApi.combined_image_vulnerability_summary ...'
  end
  # verify the required parameter 'cid' is set
  if @api_client.config.client_side_validation && cid.nil?
    fail ArgumentError, "Missing the required parameter 'cid' when calling ContainerImagesApi.combined_image_vulnerability_summary"
  end
  # verify the required parameter 'registry' is set
  if @api_client.config.client_side_validation && registry.nil?
    fail ArgumentError, "Missing the required parameter 'registry' when calling ContainerImagesApi.combined_image_vulnerability_summary"
  end
  # verify the required parameter 'repository' is set
  if @api_client.config.client_side_validation && repository.nil?
    fail ArgumentError, "Missing the required parameter 'repository' when calling ContainerImagesApi.combined_image_vulnerability_summary"
  end
  # verify the required parameter 'tag' is set
  if @api_client.config.client_side_validation && tag.nil?
    fail ArgumentError, "Missing the required parameter 'tag' when calling ContainerImagesApi.combined_image_vulnerability_summary"
  end
  # resource path
  local_var_path = '/container-security/combined/images/vulnerabilities-summary/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cid'] = cid
  query_params[:'registry'] = registry
  query_params[:'repository'] = repository
  query_params[:'tag'] = tag

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

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

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

#get_combined_images(opts = {}) ⇒ ImagesExtCombinedImagesResponse

Get image assessment results by providing an FQL filter and paging details

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filters: container_id, container_running_status, cve_id, detection_name, detection_severity, first_seen, image_digest, image_id, registry, repository, tag, vulnerability_severity

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve [1-100]

  • :offset (Integer) —

    The offset from where to begin.

  • :sort (String) —

    The fields to sort the records on. Supported columns: [first_seen highest_detection_severity highest_vulnerability_severity image_digest image_id registry repository tag]

Returns:



578
579
580
581
 
# File 'lib/crimson-falcon/api/container_images_api.rb', line 578

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

#get_combined_images_with_http_info(opts = {}) ⇒ Array<(ImagesExtCombinedImagesResponse, Integer, Hash)>

Get image assessment results by providing an FQL filter and paging details

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filters: container_id, container_running_status, cve_id, detection_name, detection_severity, first_seen, image_digest, image_id, registry, repository, tag, vulnerability_severity

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve [1-100]

  • :offset (Integer) —

    The offset from where to begin.

  • :sort (String) —

    The fields to sort the records on. Supported columns: [first_seen highest_detection_severity highest_vulnerability_severity image_digest image_id registry repository tag]

Returns:



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
623
624
625
626
627
628
629
630
631
632
633
634
635
636
 
# File 'lib/crimson-falcon/api/container_images_api.rb', line 590

def get_combined_images_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImagesApi.get_combined_images ...'
  end
  # resource path
  local_var_path = '/container-security/combined/image-assessment/images/v1'

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

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

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

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

#read_combined_images_export(opts = {}) ⇒ ImagesApiCombinedImageExport

Retrieve images with an option to expand aggregated vulnerabilities/detections

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filters: arch,base_os,cid,container_id,container_running_status,cps_rating,crowdstrike_user,cve_id,detection_count,detection_name,detection_severity,first_seen,image_digest,image_id,layer_digest,package_name_version,registry,repository,tag,vulnerability_count,vulnerability_severity

  • :expand_vulnerabilities (Boolean) —

    expand vulnerabilities

  • :expand_detections (Boolean) —

    expand detections

  • :limit (Integer) —

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

  • :offset (Integer) —

    The offset from where to begin.

  • :sort (String) —

    The fields to sort the records on. Supported columns: [base_os cid containers detections firstScanned first_seen highest_detection_severity highest_vulnerability_severity image_digest image_id last_seen layers_with_vulnerabilities packages registry repository tag vulnerabilities]

Returns:



647
648
649
650
 
# File 'lib/crimson-falcon/api/container_images_api.rb', line 647

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

#read_combined_images_export_with_http_info(opts = {}) ⇒ Array<(ImagesApiCombinedImageExport, Integer, Hash)>

Retrieve images with an option to expand aggregated vulnerabilities/detections

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filters: arch,base_os,cid,container_id,container_running_status,cps_rating,crowdstrike_user,cve_id,detection_count,detection_name,detection_severity,first_seen,image_digest,image_id,layer_digest,package_name_version,registry,repository,tag,vulnerability_count,vulnerability_severity

  • :expand_vulnerabilities (Boolean) —

    expand vulnerabilities

  • :expand_detections (Boolean) —

    expand detections

  • :limit (Integer) —

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

  • :offset (Integer) —

    The offset from where to begin.

  • :sort (String) —

    The fields to sort the records on. Supported columns: [base_os cid containers detections firstScanned first_seen highest_detection_severity highest_vulnerability_severity image_digest image_id last_seen layers_with_vulnerabilities packages registry repository tag vulnerabilities]

Returns:



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

def read_combined_images_export_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImagesApi.read_combined_images_export ...'
  end
  # resource path
  local_var_path = '/container-security/combined/images/export/v1'

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

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

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

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