Class: Falcon::ContainerImages

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContainerImages

Returns a new instance of ContainerImages.



36
37
38
 
# File 'lib/crimson-falcon/api/container_images.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.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 filter fields: - `cid` - `registry` - `repository`

Returns:



43
44
45
46
 
# File 'lib/crimson-falcon/api/container_images.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 filter fields: - &#x60;cid&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60;

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.rb', line 52

def aggregate_image_assessment_history_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImages.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 => :"ContainerImages.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: ContainerImages#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 filter fields: - &#x60;ai_related&#x60; - &#x60;ai_vulnerability_count&#x60; - &#x60;arch&#x60; - &#x60;base_os&#x60; - &#x60;cid&#x60; - &#x60;container_id&#x60; - &#x60;container_running_status&#x60; - &#x60;cps_rating&#x60; - &#x60;crowdstrike_user&#x60; - &#x60;cve_id&#x60; - &#x60;detection_count&#x60; - &#x60;detection_name&#x60; - &#x60;detection_severity&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;include_base_image_vuln&#x60; - &#x60;layer_digest&#x60; - &#x60;package_name_version&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;source&#x60; - &#x60;tag&#x60; - &#x60;vulnerability_count&#x60; - &#x60;vulnerability_severity&#x60;

Returns:



101
102
103
104
 
# File 'lib/crimson-falcon/api/container_images.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 filter fields: - &#x60;arch&#x60; - &#x60;base_os&#x60; - &#x60;cid&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;source&#x60; - &#x60;tag&#x60;

Returns:



159
160
161
162
 
# File 'lib/crimson-falcon/api/container_images.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 filter fields: - &#x60;arch&#x60; - &#x60;base_os&#x60; - &#x60;cid&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;source&#x60; - &#x60;tag&#x60;

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.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: ContainerImages.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 => :"ContainerImages.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: ContainerImages#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 filter fields: - &#x60;arch&#x60; - &#x60;base_os&#x60; - &#x60;cid&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;source&#x60; - &#x60;tag&#x60;

Returns:



217
218
219
220
 
# File 'lib/crimson-falcon/api/container_images.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 filter fields: - &#x60;arch&#x60; - &#x60;base_os&#x60; - &#x60;cid&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;source&#x60; - &#x60;tag&#x60;

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.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: ContainerImages.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 => :"ContainerImages.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: ContainerImages#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 filter fields: - &#x60;ai_related&#x60; - &#x60;ai_vulnerability_count&#x60; - &#x60;arch&#x60; - &#x60;base_os&#x60; - &#x60;cid&#x60; - &#x60;container_id&#x60; - &#x60;container_running_status&#x60; - &#x60;cps_rating&#x60; - &#x60;crowdstrike_user&#x60; - &#x60;cve_id&#x60; - &#x60;detection_count&#x60; - &#x60;detection_name&#x60; - &#x60;detection_severity&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;include_base_image_vuln&#x60; - &#x60;layer_digest&#x60; - &#x60;package_name_version&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;source&#x60; - &#x60;tag&#x60; - &#x60;vulnerability_count&#x60; - &#x60;vulnerability_severity&#x60;

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.rb', line 110

def aggregate_image_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImages.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 => :"ContainerImages.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: ContainerImages#aggregate_image_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#combined_base_images(opts = {}) ⇒ CoreEntitiesResponse

Retrieves a list of base images for the provided filter. Maximum page size: 100

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search base images using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;tag&#x60;

Returns:



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

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

#combined_base_images_with_http_info(opts = {}) ⇒ Array<(CoreEntitiesResponse, Integer, Hash)>

Retrieves a list of base images for the provided filter. Maximum page size: 100

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Search base images using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;tag&#x60;

Returns:

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

    CoreEntitiesResponse data, response status code and response headers



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

def combined_base_images_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImages.combined_base_images ...'
  end
  # resource path
  local_var_path = '/container-security/combined/base-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] || 'CoreEntitiesResponse'

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

  new_options = opts.merge(
    :operation => :"ContainerImages.combined_base_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: ContainerImages#combined_base_images\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 filter fields: - &#x60;arch&#x60; - &#x60;base_os&#x60; - &#x60;cid&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;source&#x60; - &#x60;tag&#x60;

  • :limit (Integer) —

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

  • :offset (Integer) —

    The fields to sort the records on. **Not supported.**

Returns:



335
336
337
338
 
# File 'lib/crimson-falcon/api/container_images.rb', line 335

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 filter fields: - &#x60;arch&#x60; - &#x60;base_os&#x60; - &#x60;cid&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;source&#x60; - &#x60;tag&#x60;

  • :limit (Integer) —

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

  • :offset (Integer) —

    The fields to sort the records on. **Not supported.**

Returns:



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
385
386
387
388
389
390
391
 
# File 'lib/crimson-falcon/api/container_images.rb', line 346

def combined_image_by_vulnerability_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImages.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 => :"ContainerImages.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: ContainerImages#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

Maximum offset = 10000 - limit

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;arch&#x60; - &#x60;base_os&#x60; - &#x60;cid&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;source&#x60; - &#x60;tag&#x60;

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

    include image config, default is false

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. (default to 100)

  • :offset (Integer) —

    The offset from where to begin.

Returns:



401
402
403
404
 
# File 'lib/crimson-falcon/api/container_images.rb', line 401

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)>

Maximum offset &#x3D; 10000 - limit

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;arch&#x60; - &#x60;base_os&#x60; - &#x60;cid&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;source&#x60; - &#x60;tag&#x60;

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

    include image config, default is false

  • :sort (String) —

    The fields to sort the records on.

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. (default to 100)

  • :offset (Integer) —

    The offset from where to begin.

Returns:

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

    ImagesApiCustomerAndImage data, response status code and response headers



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/crimson-falcon/api/container_images.rb', line 414

def combined_image_detail_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImages.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[:'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] || 'ImagesApiCustomerAndImage'

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

  new_options = opts.merge(
    :operation => :"ContainerImages.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: ContainerImages#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) —

    CS Customer ID

  • registry (String) —

    Registry

  • repository (String) —

    Repository name

  • tag (String) —

    Tag name

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

    the optional parameters

Options Hash (opts):

  • :image_digest (String) —

    Digest ID

  • :include_base_image_vuln (Boolean) —

    Include base image vulnerabilities. (default to false)

Returns:



472
473
474
475
 
# File 'lib/crimson-falcon/api/container_images.rb', line 472

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) —

    CS Customer ID

  • registry (String) —

    Registry

  • repository (String) —

    Repository name

  • tag (String) —

    Tag name

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

    the optional parameters

Options Hash (opts):

  • :image_digest (String) —

    Digest ID

  • :include_base_image_vuln (Boolean) —

    Include base image vulnerabilities. (default to false)

Returns:

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

    ImagesApiImageIssuesSummary data, response status code and response headers



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
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
 
# File 'lib/crimson-falcon/api/container_images.rb', line 486

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: ContainerImages.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 ContainerImages.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 ContainerImages.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 ContainerImages.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 ContainerImages.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
  query_params[:'image_digest'] = opts[:'image_digest'] if !opts[:'image_digest'].nil?
  query_params[:'include_base_image_vuln'] = opts[:'include_base_image_vuln'] if !opts[:'include_base_image_vuln'].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] || 'ImagesApiImageIssuesSummary'

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

  new_options = opts.merge(
    :operation => :"ContainerImages.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: ContainerImages#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) —

    CS Customer ID

  • registry (String) —

    Registry

  • repository (String) —

    Repository name

  • tag (String) —

    Tag name

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

    the optional parameters

Options Hash (opts):

  • :image_digest (String) —

    Digest ID

  • :include_base_image_vuln (Boolean) —

    Include base image vulnerabilities. (default to false)

Returns:



561
562
563
564
 
# File 'lib/crimson-falcon/api/container_images.rb', line 561

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) —

    CS Customer ID

  • registry (String) —

    Registry

  • repository (String) —

    Repository name

  • tag (String) —

    Tag name

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

    the optional parameters

Options Hash (opts):

  • :image_digest (String) —

    Digest ID

  • :include_base_image_vuln (Boolean) —

    Include base image vulnerabilities. (default to false)

Returns:



575
576
577
578
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
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/crimson-falcon/api/container_images.rb', line 575

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: ContainerImages.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 ContainerImages.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 ContainerImages.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 ContainerImages.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 ContainerImages.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
  query_params[:'image_digest'] = opts[:'image_digest'] if !opts[:'image_digest'].nil?
  query_params[:'include_base_image_vuln'] = opts[:'include_base_image_vuln'] if !opts[:'include_base_image_vuln'].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] || 'ImagesApiImageVulnerabilitiesSummary'

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

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

#create_base_images_entities(body, opts = {}) ⇒ CoreEntitiesResponse

Creates base images using the provided details

Parameters:

Returns:



645
646
647
648
 
# File 'lib/crimson-falcon/api/container_images.rb', line 645

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

#create_base_images_entities_with_http_info(body, opts = {}) ⇒ Array<(CoreEntitiesResponse, Integer, Hash)>

Creates base images using the provided details

Parameters:

Returns:

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

    CoreEntitiesResponse data, response status code and response headers



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

def create_base_images_entities_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImages.create_base_images_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 ContainerImages.create_base_images_entities"
  end
  # resource path
  local_var_path = '/container-security/entities/base-images/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] || 'CoreEntitiesResponse'

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

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

#delete_base_images(ids, opts = {}) ⇒ CoreEntitiesResponse

Delete base images by base image uuid

Parameters:

  • ids (Array<String>) —

    BaseImageIDs

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

    the optional parameters

Returns:



711
712
713
714
 
# File 'lib/crimson-falcon/api/container_images.rb', line 711

def delete_base_images(ids, opts = {})
  data, _status_code, _headers = delete_base_images_with_http_info(ids, opts)
  data
end

#delete_base_images_with_http_info(ids, opts = {}) ⇒ Array<(CoreEntitiesResponse, Integer, Hash)>

Delete base images by base image uuid

Parameters:

  • ids (Array<String>) —

    BaseImageIDs

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

    the optional parameters

Returns:

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

    CoreEntitiesResponse data, response status code and response headers



720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'lib/crimson-falcon/api/container_images.rb', line 720

def delete_base_images_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImages.delete_base_images ...'
  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 ContainerImages.delete_base_images"
  end
  # resource path
  local_var_path = '/container-security/entities/base-images/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] || 'CoreEntitiesResponse'

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

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

#get_combined_images(opts = {}) ⇒ ImagesExtCombinedImagesResponse

Maximum offset = 10000 - limit

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;ai_related&#x60; - &#x60;container_id&#x60; - &#x60;container_running_status&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;detection_severity&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;tag&#x60; - &#x60;vulnerability_severity&#x60;

  • :sort (String) —

    The fields to sort the records on. Supported columns: - &#x60;first_seen&#x60; - &#x60;highest_detection_severity&#x60; - &#x60;highest_vulnerability_severity&#x60; - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;source&#x60; - &#x60;tag&#x60;

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. (default to 100)

  • :offset (Integer) —

    The offset from where to begin.

Returns:



776
777
778
779
 
# File 'lib/crimson-falcon/api/container_images.rb', line 776

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)>

Maximum offset &#x3D; 10000 - limit

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;ai_related&#x60; - &#x60;container_id&#x60; - &#x60;container_running_status&#x60; - &#x60;cve_id&#x60; - &#x60;detection_name&#x60; - &#x60;detection_severity&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;tag&#x60; - &#x60;vulnerability_severity&#x60;

  • :sort (String) —

    The fields to sort the records on. Supported columns: - &#x60;first_seen&#x60; - &#x60;highest_detection_severity&#x60; - &#x60;highest_vulnerability_severity&#x60; - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;source&#x60; - &#x60;tag&#x60;

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. (default to 100)

  • :offset (Integer) —

    The offset from where to begin.

Returns:



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

def get_combined_images_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImages.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[:'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] || 'ImagesExtCombinedImagesResponse'

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

  new_options = opts.merge(
    :operation => :"ContainerImages.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: ContainerImages#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

Maximum offset = 10000 - limit

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;ai_related&#x60; - &#x60;ai_vulnerability_count&#x60; - &#x60;arch&#x60; - &#x60;base_os&#x60; - &#x60;cid&#x60; - &#x60;container_id&#x60; - &#x60;container_running_status&#x60; - &#x60;cps_rating&#x60; - &#x60;crowdstrike_user&#x60; - &#x60;cve_id&#x60; - &#x60;detection_count&#x60; - &#x60;detection_name&#x60; - &#x60;detection_severity&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;include_base_image_vuln&#x60; - &#x60;layer_digest&#x60; - &#x60;package_name_version&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;source&#x60; - &#x60;tag&#x60; - &#x60;vulnerability_count&#x60; - &#x60;vulnerability_severity&#x60;

  • :expand_vulnerabilities (Boolean) —

    Expand vulnerabilities details (default to false)

  • :expand_detections (Boolean) —

    Expand detections details (default to false)

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. (default to 100)

  • :offset (Integer) —

    The offset from where to begin.

  • :sort (String) —

    The fields to sort the records on. Supported columns: - &#x60;ai_vulnerabilities&#x60; - &#x60;base_os&#x60; - &#x60;cid&#x60; - &#x60;detections&#x60; - &#x60;firstScanned&#x60; - &#x60;first_seen&#x60; - &#x60;highest_cps_current_rating&#x60; - &#x60;highest_detection_severity&#x60; - &#x60;highest_vulnerability_severity&#x60; - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;last_seen&#x60; - &#x60;layers_with_vulnerabilities&#x60; - &#x60;packages&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;source&#x60; - &#x60;tag&#x60; - &#x60;vulnerabilities&#x60;

Returns:



845
846
847
848
 
# File 'lib/crimson-falcon/api/container_images.rb', line 845

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)>

Maximum offset &#x3D; 10000 - limit

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filter fields: - &#x60;ai_related&#x60; - &#x60;ai_vulnerability_count&#x60; - &#x60;arch&#x60; - &#x60;base_os&#x60; - &#x60;cid&#x60; - &#x60;container_id&#x60; - &#x60;container_running_status&#x60; - &#x60;cps_rating&#x60; - &#x60;crowdstrike_user&#x60; - &#x60;cve_id&#x60; - &#x60;detection_count&#x60; - &#x60;detection_name&#x60; - &#x60;detection_severity&#x60; - &#x60;first_seen&#x60; - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;include_base_image_vuln&#x60; - &#x60;layer_digest&#x60; - &#x60;package_name_version&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;source&#x60; - &#x60;tag&#x60; - &#x60;vulnerability_count&#x60; - &#x60;vulnerability_severity&#x60;

  • :expand_vulnerabilities (Boolean) —

    Expand vulnerabilities details (default to false)

  • :expand_detections (Boolean) —

    Expand detections details (default to false)

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve. (default to 100)

  • :offset (Integer) —

    The offset from where to begin.

  • :sort (String) —

    The fields to sort the records on. Supported columns: - &#x60;ai_vulnerabilities&#x60; - &#x60;base_os&#x60; - &#x60;cid&#x60; - &#x60;detections&#x60; - &#x60;firstScanned&#x60; - &#x60;first_seen&#x60; - &#x60;highest_cps_current_rating&#x60; - &#x60;highest_detection_severity&#x60; - &#x60;highest_vulnerability_severity&#x60; - &#x60;image_digest&#x60; - &#x60;image_id&#x60; - &#x60;last_seen&#x60; - &#x60;layers_with_vulnerabilities&#x60; - &#x60;packages&#x60; - &#x60;registry&#x60; - &#x60;repository&#x60; - &#x60;source&#x60; - &#x60;tag&#x60; - &#x60;vulnerabilities&#x60;

Returns:



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

def read_combined_images_export_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContainerImages.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 => :"ContainerImages.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: ContainerImages#read_combined_images_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end