Skip to content

Latest commit

 

History

History
803 lines (569 loc) · 40 KB

ComplianceAssessments.md

File metadata and controls

803 lines (569 loc) · 40 KB

Falcon::ComplianceAssessments

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

Method HTTP request Description
ext_aggregate_cluster_assessments GET /container-compliance/aggregates/compliance-by-clusters/v2 get the assessments for each cluster
ext_aggregate_failed_containers_by_rules_path GET /container-compliance/aggregates/failed-containers-by-rules/v2 get the containers grouped into rules on which they failed
ext_aggregate_failed_containers_count_by_severity GET /container-compliance/aggregates/failed-containers-count-by-severity/v2 get the failed containers count grouped into severity levels
ext_aggregate_failed_images_by_rules_path GET /container-compliance/aggregates/failed-images-by-rules/v2 get the images grouped into rules on which they failed
ext_aggregate_failed_images_count_by_severity GET /container-compliance/aggregates/failed-images-count-by-severity/v2 get the failed images count grouped into severity levels
ext_aggregate_failed_rules_by_clusters GET /container-compliance/aggregates/failed-rules-by-clusters/v2 get the failed rules for each cluster grouped into severity levels
ext_aggregate_failed_rules_by_images GET /container-compliance/aggregates/failed-rules-by-images/v2 get images with failed rules, rule count grouped by severity for each image
ext_aggregate_failed_rules_count_by_severity GET /container-compliance/aggregates/failed-rules-count-by-severity/v2 get the failed rules count grouped into severity levels
ext_aggregate_image_assessments GET /container-compliance/aggregates/compliance-by-images/v2 get the assessments for each image
ext_aggregate_rules_assessments GET /container-compliance/aggregates/compliance-by-rules/v2 get the assessments for each rule
ext_aggregate_rules_by_status GET /container-compliance/aggregates/rules-by-status/v2 get the rules grouped by their statuses

ext_aggregate_cluster_assessments

ext_aggregate_cluster_assessments(opts)

get the assessments for each cluster

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::ComplianceAssessments.new
opts = {
  filter: 'filter_example' # String | Filter results using a query in Falcon Query Language (FQL). Supported Filters: cloud_info.cluster_name: Kubernetes cluster name cloud_info.namespace: Kubernetes namespace cid: Customer ID cloud_info.cloud_account_id: Cloud account ID cloud_info.cloud_provider: Cloud provider cloud_info.cloud_region: Cloud region compliance_finding.framework: Compliance finding framework (available values: CIS) 
}

begin
  # get the assessments for each cluster
  result = api_instance.ext_aggregate_cluster_assessments(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_cluster_assessments: #{e}"
end

Using the ext_aggregate_cluster_assessments_with_http_info variant

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

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

begin
  # get the assessments for each cluster
  data, status_code, headers = api_instance.ext_aggregate_cluster_assessments_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DomainAggregateClusterAssessmentsResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_cluster_assessments_with_http_info: #{e}"
end

Parameters

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

Return type

DomainAggregateClusterAssessmentsResponse

Authorization

oauth2

HTTP request headers

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

ext_aggregate_failed_containers_by_rules_path

ext_aggregate_failed_containers_by_rules_path(opts)

get the containers grouped into rules on which they failed

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::ComplianceAssessments.new
opts = {
  filter: 'filter_example' # String | Filter results using a query in Falcon Query Language (FQL). Supported Filters: compliance_finding.name: Compliance finding Name cloud_info.namespace: Kubernetes namespace cloud_info.cloud_provider: Cloud provider compliance_finding.framework: Compliance finding framework (available values: CIS) compliance_finding.id: Compliance finding ID image_digest: Image digest (sha256 digest) cloud_info.cloud_region: Cloud region image_registry: Image registry compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) image_repository: Image repository cid: Customer ID image_id: Image ID image_tag: Image tag cloud_info.cloud_account_id: Cloud account ID cloud_info.cluster_name: Kubernetes cluster name 
}

begin
  # get the containers grouped into rules on which they failed
  result = api_instance.ext_aggregate_failed_containers_by_rules_path(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_failed_containers_by_rules_path: #{e}"
end

Using the ext_aggregate_failed_containers_by_rules_path_with_http_info variant

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

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

begin
  # get the containers grouped into rules on which they failed
  data, status_code, headers = api_instance.ext_aggregate_failed_containers_by_rules_path_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DomainAggregateFailedAssetsByRulesResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_failed_containers_by_rules_path_with_http_info: #{e}"
end

Parameters

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

Return type

DomainAggregateFailedAssetsByRulesResponse

Authorization

oauth2

HTTP request headers

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

ext_aggregate_failed_containers_count_by_severity

ext_aggregate_failed_containers_count_by_severity(opts)

get the failed containers count grouped into severity levels

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::ComplianceAssessments.new
opts = {
  filter: 'filter_example' # String | Filter results using a query in Falcon Query Language (FQL). Supported Filters: cloud_info.namespace: Kubernetes namespace compliance_finding.framework: Compliance finding framework (available values: CIS) cloud_info.cluster_name: Kubernetes cluster name cloud_info.cloud_provider: Cloud provider image_repository: Image repository cid: Customer ID image_tag: Image tag image_registry: Image registry compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) image_digest: Image digest (sha256 digest) cloud_info.cloud_account_id: Cloud account ID cloud_info.cloud_region: Cloud region image_id: Image ID compliance_finding.name: Compliance finding Name compliance_finding.id: Compliance finding ID 
}

begin
  # get the failed containers count grouped into severity levels
  result = api_instance.ext_aggregate_failed_containers_count_by_severity(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_failed_containers_count_by_severity: #{e}"
end

Using the ext_aggregate_failed_containers_count_by_severity_with_http_info variant

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

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

begin
  # get the failed containers count grouped into severity levels
  data, status_code, headers = api_instance.ext_aggregate_failed_containers_count_by_severity_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DomainAggregateFailedAssetCountBySeverityResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_failed_containers_count_by_severity_with_http_info: #{e}"
end

Parameters

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

Return type

DomainAggregateFailedAssetCountBySeverityResponse

Authorization

oauth2

HTTP request headers

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

ext_aggregate_failed_images_by_rules_path

ext_aggregate_failed_images_by_rules_path(opts)

get the images grouped into rules on which they failed

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::ComplianceAssessments.new
opts = {
  filter: 'filter_example' # String | Filter results using a query in Falcon Query Language (FQL). Supported Filters: compliance_finding.id: Compliance finding ID compliance_finding.name: Compliance finding Name compliance_finding.framework: Compliance finding framework (available values: CIS) cloud_info.namespace: Kubernetes namespace image_repository: Image repository image_digest: Image digest (sha256 digest) image_tag: Image tag image_id: Image ID image_registry: Image registry cloud_info.cloud_account_id: Cloud account ID cloud_info.cloud_region: Cloud region cid: Customer ID compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cloud_info.cluster_name: Kubernetes cluster name cloud_info.cloud_provider: Cloud provider 
}

begin
  # get the images grouped into rules on which they failed
  result = api_instance.ext_aggregate_failed_images_by_rules_path(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_failed_images_by_rules_path: #{e}"
end

Using the ext_aggregate_failed_images_by_rules_path_with_http_info variant

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

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

begin
  # get the images grouped into rules on which they failed
  data, status_code, headers = api_instance.ext_aggregate_failed_images_by_rules_path_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DomainAggregateFailedAssetsByRulesResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_failed_images_by_rules_path_with_http_info: #{e}"
end

Parameters

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

Return type

DomainAggregateFailedAssetsByRulesResponse

Authorization

oauth2

HTTP request headers

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

ext_aggregate_failed_images_count_by_severity

ext_aggregate_failed_images_count_by_severity(opts)

get the failed images count grouped into severity levels

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::ComplianceAssessments.new
opts = {
  filter: 'filter_example' # String | Filter results using a query in Falcon Query Language (FQL). Supported Filters: compliance_finding.name: Compliance finding Name image_registry: Image registry cloud_info.cluster_name: Kubernetes cluster name compliance_finding.id: Compliance finding ID image_id: Image ID image_tag: Image tag cloud_info.cloud_account_id: Cloud account ID compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) cloud_info.namespace: Kubernetes namespace image_digest: Image digest (sha256 digest) cloud_info.cloud_provider: Cloud provider cloud_info.cloud_region: Cloud region compliance_finding.framework: Compliance finding framework (available values: CIS) image_repository: Image repository cid: Customer ID 
}

begin
  # get the failed images count grouped into severity levels
  result = api_instance.ext_aggregate_failed_images_count_by_severity(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_failed_images_count_by_severity: #{e}"
end

Using the ext_aggregate_failed_images_count_by_severity_with_http_info variant

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

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

begin
  # get the failed images count grouped into severity levels
  data, status_code, headers = api_instance.ext_aggregate_failed_images_count_by_severity_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DomainAggregateFailedAssetCountBySeverityResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_failed_images_count_by_severity_with_http_info: #{e}"
end

Parameters

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

Return type

DomainAggregateFailedAssetCountBySeverityResponse

Authorization

oauth2

HTTP request headers

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

ext_aggregate_failed_rules_by_clusters

ext_aggregate_failed_rules_by_clusters(opts)

get the failed rules for each cluster grouped into severity levels

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::ComplianceAssessments.new
opts = {
  filter: 'filter_example' # String | Filter results using a query in Falcon Query Language (FQL). Supported Filters: image_registry: Image registry compliance_finding.framework: Compliance finding framework (available values: CIS) compliance_finding.id: Compliance finding ID image_tag: Image tag compliance_finding.name: Compliance finding Name image_repository: Image repository cloud_info.cluster_name: Kubernetes cluster name image_digest: Image digest (sha256 digest) cloud_info.cloud_provider: Cloud provider image_id: Image ID cloud_info.cloud_region: Cloud region cid: Customer ID compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) asset_type: asset type (container, image) cloud_info.cloud_account_id: Cloud account ID 
}

begin
  # get the failed rules for each cluster grouped into severity levels
  result = api_instance.ext_aggregate_failed_rules_by_clusters(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_failed_rules_by_clusters: #{e}"
end

Using the ext_aggregate_failed_rules_by_clusters_with_http_info variant

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

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

begin
  # get the failed rules for each cluster grouped into severity levels
  data, status_code, headers = api_instance.ext_aggregate_failed_rules_by_clusters_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DomainAggregateFailedRulesByClustersResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_failed_rules_by_clusters_with_http_info: #{e}"
end

Parameters

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

Return type

DomainAggregateFailedRulesByClustersResponse

Authorization

oauth2

HTTP request headers

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

ext_aggregate_failed_rules_by_images

ext_aggregate_failed_rules_by_images(opts)

get images with failed rules, rule count grouped by severity for each 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::ComplianceAssessments.new
opts = {
  filter: 'filter_example' # String | Filter results using a query in Falcon Query Language (FQL). Supported Filters: cloud_info.cloud_account_id: Cloud account ID cloud_info.cloud_provider: Cloud provider cloud_info.cloud_region: Cloud region compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) image_repository: Image repository compliance_finding.framework: Compliance finding framework (available values: CIS) image_id: Image ID image_registry: Image registry asset_type: asset type (container, image) compliance_finding.name: Compliance finding Name compliance_finding.id: Compliance finding ID cid: Customer ID image_tag: Image tag cloud_info.namespace: Kubernetes namespace image_digest: Image digest (sha256 digest) cloud_info.cluster_name: Kubernetes cluster name 
}

begin
  # get images with failed rules, rule count grouped by severity for each image
  result = api_instance.ext_aggregate_failed_rules_by_images(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_failed_rules_by_images: #{e}"
end

Using the ext_aggregate_failed_rules_by_images_with_http_info variant

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

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

begin
  # get images with failed rules, rule count grouped by severity for each image
  data, status_code, headers = api_instance.ext_aggregate_failed_rules_by_images_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DomainAggregateFailedRulesByImagesResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_failed_rules_by_images_with_http_info: #{e}"
end

Parameters

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

Return type

DomainAggregateFailedRulesByImagesResponse

Authorization

oauth2

HTTP request headers

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

ext_aggregate_failed_rules_count_by_severity

ext_aggregate_failed_rules_count_by_severity(opts)

get the failed rules count grouped into severity levels

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::ComplianceAssessments.new
opts = {
  filter: 'filter_example' # String | Filter results using a query in Falcon Query Language (FQL). Supported Filters: image_digest: Image digest (sha256 digest) cloud_info.cluster_name: Kubernetes cluster name image_registry: Image registry image_id: Image ID image_tag: Image tag compliance_finding.framework: Compliance finding framework (available values: CIS) image_repository: Image repository compliance_finding.id: Compliance finding ID asset_type: asset type (container, image) cloud_info.cloud_account_id: Cloud account ID cid: Customer ID compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) compliance_finding.name: Compliance finding Name cloud_info.cloud_provider: Cloud provider cloud_info.cloud_region: Cloud region 
}

begin
  # get the failed rules count grouped into severity levels
  result = api_instance.ext_aggregate_failed_rules_count_by_severity(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_failed_rules_count_by_severity: #{e}"
end

Using the ext_aggregate_failed_rules_count_by_severity_with_http_info variant

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

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

begin
  # get the failed rules count grouped into severity levels
  data, status_code, headers = api_instance.ext_aggregate_failed_rules_count_by_severity_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DomainAggregateFailedRulesCountBySeverityResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_failed_rules_count_by_severity_with_http_info: #{e}"
end

Parameters

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

Return type

DomainAggregateFailedRulesCountBySeverityResponse

Authorization

oauth2

HTTP request headers

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

ext_aggregate_image_assessments

ext_aggregate_image_assessments(opts)

get the assessments for each 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::ComplianceAssessments.new
opts = {
  filter: 'filter_example', # String | Filter results using a query in Falcon Query Language (FQL). Supported Filters: cid: Customer ID compliance_finding.framework: Compliance finding framework (available values: CIS) image_digest: Image digest (sha256 digest) cloud_info.cloud_provider: Cloud provider cloud_info.namespace: Kubernetes namespace asset_type: asset type (container, image) cloud_info.cloud_region: Cloud region image_registry: Image registry image_repository: Image repository image_id: Image ID image_tag: Image tag cloud_info.cloud_account_id: Cloud account ID cloud_info.cluster_name: Kubernetes cluster name compliance_finding.id: Compliance finding ID compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) compliance_finding.name: Compliance finding Name 
  after: 'after_example', # String | 'after' value from the last response. Keep it empty for the first request.
  limit: 'limit_example' # String | number of images to return in the response after 'after' key. Keep it empty for the default number of 10000
}

begin
  # get the assessments for each image
  result = api_instance.ext_aggregate_image_assessments(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_image_assessments: #{e}"
end

Using the ext_aggregate_image_assessments_with_http_info variant

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

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

begin
  # get the assessments for each image
  data, status_code, headers = api_instance.ext_aggregate_image_assessments_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DomainAggregateImageAssessmentsResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_image_assessments_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
filter String Filter results using a query in Falcon Query Language (FQL). Supported Filters: cid: Customer ID compliance_finding.framework: Compliance finding framework (available values: CIS) image_digest: Image digest (sha256 digest) cloud_info.cloud_provider: Cloud provider cloud_info.namespace: Kubernetes namespace asset_type: asset type (container, image) cloud_info.cloud_region: Cloud region image_registry: Image registry image_repository: Image repository image_id: Image ID image_tag: Image tag cloud_info.cloud_account_id: Cloud account ID cloud_info.cluster_name: Kubernetes cluster name compliance_finding.id: Compliance finding ID compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) compliance_finding.name: Compliance finding Name [optional]
after String 'after' value from the last response. Keep it empty for the first request. [optional]
limit String number of images to return in the response after 'after' key. Keep it empty for the default number of 10000 [optional]

Return type

DomainAggregateImageAssessmentsResponse

Authorization

oauth2

HTTP request headers

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

ext_aggregate_rules_assessments

ext_aggregate_rules_assessments(opts)

get the assessments for each rule

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::ComplianceAssessments.new
opts = {
  filter: 'filter_example' # String | Filter results using a query in Falcon Query Language (FQL). Supported Filters: cloud_info.cloud_account_id: Cloud account ID cloud_info.cloud_provider: Cloud provider compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) image_tag: Image tag compliance_finding.framework: Compliance finding framework (available values: CIS) image_repository: Image repository compliance_finding.id: Compliance finding ID cloud_info.cloud_region: Cloud region image_id: Image ID image_registry: Image registry compliance_finding.name: Compliance finding Name image_digest: Image digest (sha256 digest) cloud_info.cluster_name: Kubernetes cluster name cid: Customer ID 
}

begin
  # get the assessments for each rule
  result = api_instance.ext_aggregate_rules_assessments(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_rules_assessments: #{e}"
end

Using the ext_aggregate_rules_assessments_with_http_info variant

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

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

begin
  # get the assessments for each rule
  data, status_code, headers = api_instance.ext_aggregate_rules_assessments_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DomainAggregateRulesAssessmentsResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_rules_assessments_with_http_info: #{e}"
end

Parameters

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

Return type

DomainAggregateRulesAssessmentsResponse

Authorization

oauth2

HTTP request headers

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

ext_aggregate_rules_by_status

ext_aggregate_rules_by_status(opts)

get the rules grouped by their statuses

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::ComplianceAssessments.new
opts = {
  filter: 'filter_example' # String | Filter results using a query in Falcon Query Language (FQL). Supported Filters: cloud_info.cluster_name: Kubernetes cluster name compliance_finding.id: Compliance finding ID cloud_info.cloud_provider: Cloud provider compliance_finding.name: Compliance finding Name compliance_finding.framework: Compliance finding framework (available values: CIS) container_name: Container name container_id: Container ID image_registry: Image registry compliance_finding.severity: Compliance finding severity; available values: 4, 3, 2, 1 (4: critical, 3: high, 2: medium, 1:low) image_digest: Image digest (sha256 digest) image_id: Image ID image_tag: Image tag image_repository: Image repository asset_type: asset type (container, image) cloud_info.cloud_account_id: Cloud account ID cloud_info.cloud_region: Cloud region cid: Customer ID 
}

begin
  # get the rules grouped by their statuses
  result = api_instance.ext_aggregate_rules_by_status(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_rules_by_status: #{e}"
end

Using the ext_aggregate_rules_by_status_with_http_info variant

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

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

begin
  # get the rules grouped by their statuses
  data, status_code, headers = api_instance.ext_aggregate_rules_by_status_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DomainAggregateRulesByStatusResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ComplianceAssessments->ext_aggregate_rules_by_status_with_http_info: #{e}"
end

Parameters

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

Return type

DomainAggregateRulesByStatusResponse

Authorization

oauth2

HTTP request headers

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