Skip to content

Latest commit

 

History

History
983 lines (707 loc) · 32.6 KB

ContainerImages.md

File metadata and controls

983 lines (707 loc) · 32.6 KB
Raw

Falcon::ContainerImages

All URIs are relative to https://api.us-2.crowdstrike.com

Method HTTP request Description
aggregate_image_assessment_history GET /container-security/aggregates/images/assessment-history/v1 Image assessment history
aggregate_image_count GET /container-security/aggregates/images/count/v1 Aggregate count of images
aggregate_image_count_by_base_os GET /container-security/aggregates/images/count-by-os-distribution/v1 Aggregate count of images grouped by Base OS distribution
aggregate_image_count_by_state GET /container-security/aggregates/images/count-by-state/v1 Aggregate count of images grouped by state
combined_base_images GET /container-security/combined/base-images/v1 Retrieve base images for provided filter
combined_image_by_vulnerability_count GET /container-security/combined/images/by-vulnerability-count/v1 Retrieve top x images with the most vulnerabilities
combined_image_detail GET /container-security/combined/images/detail/v1 Retrieve image entities identified by the provided filter criteria
combined_image_issues_summary GET /container-security/combined/images/issues-summary/v1 Retrieve image issues summary such as Image detections, Runtime detections, Policies, vulnerabilities
combined_image_vulnerability_summary GET /container-security/combined/images/vulnerabilities-summary/v1 aggregates information about vulnerabilities for an image
create_base_images_entities POST /container-security/entities/base-images/v1 Creates base images using the provided details
delete_base_images DELETE /container-security/entities/base-images/v1 Delete base images by base image uuid
get_combined_images GET /container-security/combined/image-assessment/images/v1 Get image assessment results by providing an FQL filter and paging details
read_combined_images_export GET /container-security/combined/images/export/v1 Retrieve images with an option to expand aggregated vulnerabilities/detections

aggregate_image_assessment_history

aggregate_image_assessment_history(opts)

Image assessment history

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::ContainerImages.new
opts = {
  filter: 'filter_example' # String | Filter using a query in Falcon Query Language (FQL). Supported filters:  cid,registry,repository
}

begin
  # Image assessment history
  result = api_instance.aggregate_image_assessment_history(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->aggregate_image_assessment_history: #{e}"
end

Using the aggregate_image_assessment_history_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> aggregate_image_assessment_history_with_http_info(opts)

begin
  # Image assessment history
  data, status_code, headers = api_instance.aggregate_image_assessment_history_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ImagesApiImageAssessmentHistory>
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->aggregate_image_assessment_history_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
filter String Filter using a query in Falcon Query Language (FQL). Supported filters: cid,registry,repository [optional]

Return type

ImagesApiImageAssessmentHistory

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

aggregate_image_count

aggregate_image_count(opts)

Aggregate count of images

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::ContainerImages.new
opts = {
  filter: 'filter_example' # 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,include_base_image_vuln,layer_digest,package_name_version,registry,repository,source,tag,vulnerability_count,vulnerability_severity
}

begin
  # Aggregate count of images
  result = api_instance.aggregate_image_count(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->aggregate_image_count: #{e}"
end

Using the aggregate_image_count_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> aggregate_image_count_with_http_info(opts)

begin
  # Aggregate count of images
  data, status_code, headers = api_instance.aggregate_image_count_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ImagesApiImageCount>
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->aggregate_image_count_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
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,include_base_image_vuln,layer_digest,package_name_version,registry,repository,source,tag,vulnerability_count,vulnerability_severity [optional]

Return type

ImagesApiImageCount

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

aggregate_image_count_by_base_os

aggregate_image_count_by_base_os(opts)

Aggregate count of images grouped by Base OS distribution

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::ContainerImages.new
opts = {
  filter: 'filter_example' # String | Filter images using a query in Falcon Query Language (FQL). Supported filters:  arch,base_os,cid,registry,repository,tag
}

begin
  # Aggregate count of images grouped by Base OS distribution
  result = api_instance.aggregate_image_count_by_base_os(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->aggregate_image_count_by_base_os: #{e}"
end

Using the aggregate_image_count_by_base_os_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> aggregate_image_count_by_base_os_with_http_info(opts)

begin
  # Aggregate count of images grouped by Base OS distribution
  data, status_code, headers = api_instance.aggregate_image_count_by_base_os_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ImagesApiImageCountByBaseOS>
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->aggregate_image_count_by_base_os_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
filter String Filter images using a query in Falcon Query Language (FQL). Supported filters: arch,base_os,cid,registry,repository,tag [optional]

Return type

ImagesApiImageCountByBaseOS

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

aggregate_image_count_by_state

aggregate_image_count_by_state(opts)

Aggregate count of images grouped by state

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::ContainerImages.new
opts = {
  filter: 'filter_example' # String | Filter images using a query in Falcon Query Language (FQL). Supported filters:  cid,last_seen,registry,repository
}

begin
  # Aggregate count of images grouped by state
  result = api_instance.aggregate_image_count_by_state(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->aggregate_image_count_by_state: #{e}"
end

Using the aggregate_image_count_by_state_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> aggregate_image_count_by_state_with_http_info(opts)

begin
  # Aggregate count of images grouped by state
  data, status_code, headers = api_instance.aggregate_image_count_by_state_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ImagesApiImageCountByState>
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->aggregate_image_count_by_state_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
filter String Filter images using a query in Falcon Query Language (FQL). Supported filters: cid,last_seen,registry,repository [optional]

Return type

ImagesApiImageCountByState

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

combined_base_images

combined_base_images(opts)

Retrieve base images for provided filter

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::ContainerImages.new
opts = {
  filter: 'filter_example' # String | Search base images using a query in Falcon Query Language (FQL). Supported filters:  image_digest,image_id,registry,repository,tag
}

begin
  # Retrieve base images for provided filter
  result = api_instance.combined_base_images(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->combined_base_images: #{e}"
end

Using the combined_base_images_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> combined_base_images_with_http_info(opts)

begin
  # Retrieve base images for provided filter
  data, status_code, headers = api_instance.combined_base_images_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CoreEntitiesResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->combined_base_images_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
filter String Search base images using a query in Falcon Query Language (FQL). Supported filters: image_digest,image_id,registry,repository,tag [optional]

Return type

CoreEntitiesResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

combined_image_by_vulnerability_count

combined_image_by_vulnerability_count(opts)

Retrieve top x images with the most vulnerabilities

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::ContainerImages.new
opts = {
  filter: 'filter_example', # String | Filter images using a query in Falcon Query Language (FQL). Supported filters:  arch,base_os,cid,registry,repository,tag
  limit: 56, # Integer | The upper-bound on the number of records to retrieve.
  offset: 56 # Integer | This is not used in the backend but is added here for compatibility purposes as some clients expects this i.e UI widgets.
}

begin
  # Retrieve top x images with the most vulnerabilities
  result = api_instance.combined_image_by_vulnerability_count(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->combined_image_by_vulnerability_count: #{e}"
end

Using the combined_image_by_vulnerability_count_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> combined_image_by_vulnerability_count_with_http_info(opts)

begin
  # Retrieve top x images with the most vulnerabilities
  data, status_code, headers = api_instance.combined_image_by_vulnerability_count_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ImagesApiImageByVulnerabilityCount>
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->combined_image_by_vulnerability_count_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
filter String Filter images using a query in Falcon Query Language (FQL). Supported filters: arch,base_os,cid,registry,repository,tag [optional]
limit Integer The upper-bound on the number of records to retrieve. [optional]
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. [optional]

Return type

ImagesApiImageByVulnerabilityCount

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

combined_image_detail

combined_image_detail(opts)

Retrieve image entities identified by the provided filter criteria

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::ContainerImages.new
opts = {
  filter: 'filter_example', # String | Filter images using a query in Falcon Query Language (FQL). Supported filters:  registry,repository,tag
  with_config: true, # Boolean | (true/false) include image config, default is false
  limit: 56, # Integer | The upper-bound on the number of records to retrieve.
  offset: 56, # Integer | The offset from where to begin.
  sort: 'sort_example' # String | The fields to sort the records on.
}

begin
  # Retrieve image entities identified by the provided filter criteria
  result = api_instance.combined_image_detail(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->combined_image_detail: #{e}"
end

Using the combined_image_detail_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> combined_image_detail_with_http_info(opts)

begin
  # Retrieve image entities identified by the provided filter criteria
  data, status_code, headers = api_instance.combined_image_detail_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ImagesApiCustomerAndImage>
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->combined_image_detail_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
filter String Filter images using a query in Falcon Query Language (FQL). Supported filters: registry,repository,tag [optional]
with_config Boolean (true/false) include image config, default is false [optional]
limit Integer The upper-bound on the number of records to retrieve. [optional]
offset Integer The offset from where to begin. [optional]
sort String The fields to sort the records on. [optional]

Return type

ImagesApiCustomerAndImage

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

combined_image_issues_summary

combined_image_issues_summary(cid, registry, repository, tag, opts)

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

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::ContainerImages.new
cid = 'cid_example' # String | CID
registry = 'registry_example' # String | registry name
repository = 'repository_example' # String | repository name
tag = 'tag_example' # String | tag name
opts = {
  include_base_image_vuln: true # Boolean | include base image vulnerabilities
}

begin
  # Retrieve image issues summary such as Image detections, Runtime detections, Policies, vulnerabilities
  result = api_instance.combined_image_issues_summary(cid, registry, repository, tag, opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->combined_image_issues_summary: #{e}"
end

Using the combined_image_issues_summary_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> combined_image_issues_summary_with_http_info(cid, registry, repository, tag, opts)

begin
  # Retrieve image issues summary such as Image detections, Runtime detections, Policies, vulnerabilities
  data, status_code, headers = api_instance.combined_image_issues_summary_with_http_info(cid, registry, repository, tag, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ImagesApiImageIssuesSummary>
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->combined_image_issues_summary_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
cid String CID
registry String registry name
repository String repository name
tag String tag name
include_base_image_vuln Boolean include base image vulnerabilities [optional]

Return type

ImagesApiImageIssuesSummary

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

combined_image_vulnerability_summary

combined_image_vulnerability_summary(cid, registry, repository, tag, opts)

aggregates information about vulnerabilities for an image

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::ContainerImages.new
cid = 'cid_example' # String | CID
registry = 'registry_example' # String | registry name
repository = 'repository_example' # String | repository name
tag = 'tag_example' # String | tag name
opts = {
  include_base_image_vuln: true # Boolean | include base image vulnerabilities
}

begin
  # aggregates information about vulnerabilities for an image
  result = api_instance.combined_image_vulnerability_summary(cid, registry, repository, tag, opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->combined_image_vulnerability_summary: #{e}"
end

Using the combined_image_vulnerability_summary_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> combined_image_vulnerability_summary_with_http_info(cid, registry, repository, tag, opts)

begin
  # aggregates information about vulnerabilities for an image
  data, status_code, headers = api_instance.combined_image_vulnerability_summary_with_http_info(cid, registry, repository, tag, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ImagesApiImageVulnerabilitiesSummary>
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->combined_image_vulnerability_summary_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
cid String CID
registry String registry name
repository String repository name
tag String tag name
include_base_image_vuln Boolean include base image vulnerabilities [optional]

Return type

ImagesApiImageVulnerabilitiesSummary

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

create_base_images_entities

create_base_images_entities(body)

Creates base images using the provided details

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::ContainerImages.new
body = Falcon::ModelsCreateBaseImagesRequest.new({base_images: [Falcon::ModelsBaseImageRequest.new]}) # ModelsCreateBaseImagesRequest | 

begin
  # Creates base images using the provided details
  result = api_instance.create_base_images_entities(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->create_base_images_entities: #{e}"
end

Using the create_base_images_entities_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_base_images_entities_with_http_info(body)

begin
  # Creates base images using the provided details
  data, status_code, headers = api_instance.create_base_images_entities_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CoreEntitiesResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->create_base_images_entities_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
body ModelsCreateBaseImagesRequest

Return type

CoreEntitiesResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

delete_base_images

delete_base_images(ids)

Delete base images by base image uuid

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::ContainerImages.new
ids = ['inner_example'] # Array<String> | BaseImageIDs

begin
  # Delete base images by base image uuid
  result = api_instance.delete_base_images(ids)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->delete_base_images: #{e}"
end

Using the delete_base_images_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> delete_base_images_with_http_info(ids)

begin
  # Delete base images by base image uuid
  data, status_code, headers = api_instance.delete_base_images_with_http_info(ids)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CoreEntitiesResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->delete_base_images_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
ids Array<String> BaseImageIDs

Return type

CoreEntitiesResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_combined_images

get_combined_images(opts)

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

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::ContainerImages.new
opts = {
  filter: 'filter_example', # 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: 56, # Integer | The upper-bound on the number of records to retrieve [1-100]
  offset: 56, # Integer | The offset from where to begin.
  sort: 'sort_example' # String | The fields to sort the records on. Supported columns:  [first_seen highest_detection_severity highest_vulnerability_severity image_digest image_id registry repository source tag]
}

begin
  # Get image assessment results by providing an FQL filter and paging details
  result = api_instance.get_combined_images(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->get_combined_images: #{e}"
end

Using the get_combined_images_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_combined_images_with_http_info(opts)

begin
  # Get image assessment results by providing an FQL filter and paging details
  data, status_code, headers = api_instance.get_combined_images_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ImagesExtCombinedImagesResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->get_combined_images_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
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 [optional]
limit Integer The upper-bound on the number of records to retrieve [1-100] [optional]
offset Integer The offset from where to begin. [optional]
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 source tag] [optional]

Return type

ImagesExtCombinedImagesResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

read_combined_images_export

read_combined_images_export(opts)

Retrieve images with an option to expand aggregated vulnerabilities/detections

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::ContainerImages.new
opts = {
  filter: 'filter_example', # 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,include_base_image_vuln,layer_digest,package_name_version,registry,repository,source,tag,vulnerability_count,vulnerability_severity
  expand_vulnerabilities: true, # Boolean | expand vulnerabilities
  expand_detections: true, # Boolean | expand detections
  limit: 56, # Integer | The upper-bound on the number of records to retrieve.
  offset: 56, # Integer | The offset from where to begin.
  sort: 'sort_example' # String | The fields to sort the records on. Supported columns:  [base_os cid detections firstScanned first_seen highest_cps_current_rating highest_detection_severity highest_vulnerability_severity image_digest image_id last_seen layers_with_vulnerabilities packages registry repository source tag vulnerabilities]
}

begin
  # Retrieve images with an option to expand aggregated vulnerabilities/detections
  result = api_instance.read_combined_images_export(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->read_combined_images_export: #{e}"
end

Using the read_combined_images_export_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> read_combined_images_export_with_http_info(opts)

begin
  # Retrieve images with an option to expand aggregated vulnerabilities/detections
  data, status_code, headers = api_instance.read_combined_images_export_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ImagesApiCombinedImageExport>
rescue Falcon::ApiError => e
  puts "Error when calling ContainerImages->read_combined_images_export_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
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,include_base_image_vuln,layer_digest,package_name_version,registry,repository,source,tag,vulnerability_count,vulnerability_severity [optional]
expand_vulnerabilities Boolean expand vulnerabilities [optional]
expand_detections Boolean expand detections [optional]
limit Integer The upper-bound on the number of records to retrieve. [optional]
offset Integer The offset from where to begin. [optional]
sort String The fields to sort the records on. Supported columns: [base_os cid detections firstScanned first_seen highest_cps_current_rating highest_detection_severity highest_vulnerability_severity image_digest image_id last_seen layers_with_vulnerabilities packages registry repository source tag vulnerabilities] [optional]

Return type

ImagesApiCombinedImageExport

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json