Skip to content

Latest commit

 

History

History
772 lines (538 loc) · 21 KB

ImageAssessmentPolicies.md

File metadata and controls

772 lines (538 loc) · 21 KB
Raw

Falcon::ImageAssessmentPolicies

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

Method HTTP request Description
create_policies POST /container-security/entities/image-assessment-policies/v1 Create Image Assessment policies
create_policy_groups POST /container-security/entities/image-assessment-policy-groups/v1 Create Image Assessment Policy Group entities
delete_policy DELETE /container-security/entities/image-assessment-policies/v1 Delete Image Assessment Policy by policy UUID
delete_policy_group DELETE /container-security/entities/image-assessment-policy-groups/v1 Delete Image Assessment Policy Group entities
read_policies GET /container-security/entities/image-assessment-policies/v1 Get all Image Assessment policies
read_policy_exclusions GET /container-security/entities/image-assessment-policy-exclusions/v1 Retrieve Image Assessment Policy Exclusion entities
read_policy_groups GET /container-security/entities/image-assessment-policy-groups/v1 Retrieve Image Assessment Policy Group entities
update_policies PATCH /container-security/entities/image-assessment-policies/v1 Update Image Assessment Policy entities
update_policy_exclusions POST /container-security/entities/image-assessment-policy-exclusions/v1 Update Image Assessment Policy Exclusion entities
update_policy_groups PATCH /container-security/entities/image-assessment-policy-groups/v1 Update Image Assessment Policy Group entities
update_policy_precedence POST /container-security/entities/image-assessment-policy-precedence/v1 Update Image Assessment Policy precedence

create_policies

create_policies(body)

Create Image Assessment policies

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::ImageAssessmentPolicies.new
body = Falcon::ModelsCreatePolicyRequest.new({description: 'description_example', name: 'name_example'}) # ModelsCreatePolicyRequest | 

begin
  # Create Image Assessment policies
  result = api_instance.create_policies(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->create_policies: #{e}"
end

Using the create_policies_with_http_info variant

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

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

begin
  # Create Image Assessment policies
  data, status_code, headers = api_instance.create_policies_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ModelsPolicyEntityResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->create_policies_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
body ModelsCreatePolicyRequest

Return type

ModelsPolicyEntityResponse

Authorization

oauth2

HTTP request headers

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

create_policy_groups

create_policy_groups(body)

Create Image Assessment Policy Group entities

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::ImageAssessmentPolicies.new
body = Falcon::ModelsCreateImageGroupRequest.new({description: 'description_example', name: 'name_example'}) # ModelsCreateImageGroupRequest | 

begin
  # Create Image Assessment Policy Group entities
  result = api_instance.create_policy_groups(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->create_policy_groups: #{e}"
end

Using the create_policy_groups_with_http_info variant

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

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

begin
  # Create Image Assessment Policy Group entities
  data, status_code, headers = api_instance.create_policy_groups_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ModelsPolicyGroupEntityResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->create_policy_groups_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
body ModelsCreateImageGroupRequest

Return type

ModelsPolicyGroupEntityResponse

Authorization

oauth2

HTTP request headers

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

delete_policy

delete_policy(id)

Delete Image Assessment Policy by policy 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::ImageAssessmentPolicies.new
id = 'id_example' # String | Image Assessment Policy entity UUID

begin
  # Delete Image Assessment Policy by policy UUID
  result = api_instance.delete_policy(id)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->delete_policy: #{e}"
end

Using the delete_policy_with_http_info variant

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

<Array(, Integer, Hash)> delete_policy_with_http_info(id)

begin
  # Delete Image Assessment Policy by policy UUID
  data, status_code, headers = api_instance.delete_policy_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CoreEntitiesResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->delete_policy_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Image Assessment Policy entity UUID

Return type

CoreEntitiesResponse

Authorization

oauth2

HTTP request headers

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

delete_policy_group

delete_policy_group(id)

Delete Image Assessment Policy Group entities

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::ImageAssessmentPolicies.new
id = 'id_example' # String | Policy Image Group entity UUID

begin
  # Delete Image Assessment Policy Group entities
  result = api_instance.delete_policy_group(id)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->delete_policy_group: #{e}"
end

Using the delete_policy_group_with_http_info variant

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

<Array(, Integer, Hash)> delete_policy_group_with_http_info(id)

begin
  # Delete Image Assessment Policy Group entities
  data, status_code, headers = api_instance.delete_policy_group_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CoreEntitiesResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->delete_policy_group_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Policy Image Group entity UUID

Return type

CoreEntitiesResponse

Authorization

oauth2

HTTP request headers

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

read_policies

read_policies

Get all Image Assessment policies

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::ImageAssessmentPolicies.new

begin
  # Get all Image Assessment policies
  result = api_instance.read_policies
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->read_policies: #{e}"
end

Using the read_policies_with_http_info variant

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

<Array(, Integer, Hash)> read_policies_with_http_info

begin
  # Get all Image Assessment policies
  data, status_code, headers = api_instance.read_policies_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ModelsPolicyEntityResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->read_policies_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

ModelsPolicyEntityResponse

Authorization

oauth2

HTTP request headers

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

read_policy_exclusions

read_policy_exclusions

Retrieve Image Assessment Policy Exclusion entities

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::ImageAssessmentPolicies.new

begin
  # Retrieve Image Assessment Policy Exclusion entities
  result = api_instance.read_policy_exclusions
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->read_policy_exclusions: #{e}"
end

Using the read_policy_exclusions_with_http_info variant

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

<Array(, Integer, Hash)> read_policy_exclusions_with_http_info

begin
  # Retrieve Image Assessment Policy Exclusion entities
  data, status_code, headers = api_instance.read_policy_exclusions_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ModelsPolicyExclusionEntityResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->read_policy_exclusions_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

ModelsPolicyExclusionEntityResponse

Authorization

oauth2

HTTP request headers

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

read_policy_groups

read_policy_groups

Retrieve Image Assessment Policy Group entities

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::ImageAssessmentPolicies.new

begin
  # Retrieve Image Assessment Policy Group entities
  result = api_instance.read_policy_groups
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->read_policy_groups: #{e}"
end

Using the read_policy_groups_with_http_info variant

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

<Array(, Integer, Hash)> read_policy_groups_with_http_info

begin
  # Retrieve Image Assessment Policy Group entities
  data, status_code, headers = api_instance.read_policy_groups_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ModelsPolicyGroupEntityResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->read_policy_groups_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

ModelsPolicyGroupEntityResponse

Authorization

oauth2

HTTP request headers

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

update_policies

update_policies(id, body)

Update Image Assessment Policy entities

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::ImageAssessmentPolicies.new
id = 'id_example' # String | Image Assessment Policy entity UUID
body = Falcon::ModelsPatchPolicyRequest.new({description: 'description_example', is_enabled: false, name: 'name_example'}) # ModelsPatchPolicyRequest | 

begin
  # Update Image Assessment Policy entities
  result = api_instance.update_policies(id, body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->update_policies: #{e}"
end

Using the update_policies_with_http_info variant

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

<Array(, Integer, Hash)> update_policies_with_http_info(id, body)

begin
  # Update Image Assessment Policy entities
  data, status_code, headers = api_instance.update_policies_with_http_info(id, body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ModelsPolicyEntityResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->update_policies_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Image Assessment Policy entity UUID
body ModelsPatchPolicyRequest

Return type

ModelsPolicyEntityResponse

Authorization

oauth2

HTTP request headers

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

update_policy_exclusions

update_policy_exclusions(body)

Update Image Assessment Policy Exclusion entities

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::ImageAssessmentPolicies.new
body = Falcon::ModelsUpdateExclusionsRequest.new({conditions: [Falcon::ModelsExclusionConditionRequest.new({prop: 'prop_example', value: ['value_example']})]}) # ModelsUpdateExclusionsRequest | 

begin
  # Update Image Assessment Policy Exclusion entities
  result = api_instance.update_policy_exclusions(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->update_policy_exclusions: #{e}"
end

Using the update_policy_exclusions_with_http_info variant

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

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

begin
  # Update Image Assessment Policy Exclusion entities
  data, status_code, headers = api_instance.update_policy_exclusions_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ModelsPolicyExclusionEntityResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->update_policy_exclusions_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
body ModelsUpdateExclusionsRequest

Return type

ModelsPolicyExclusionEntityResponse

Authorization

oauth2

HTTP request headers

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

update_policy_groups

update_policy_groups(id, body)

Update Image Assessment Policy Group entities

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::ImageAssessmentPolicies.new
id = 'id_example' # String | Policy Image Group entity UUID
body = Falcon::ModelsPatchImageGroupRequest.new({description: 'description_example', name: 'name_example'}) # ModelsPatchImageGroupRequest | 

begin
  # Update Image Assessment Policy Group entities
  result = api_instance.update_policy_groups(id, body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->update_policy_groups: #{e}"
end

Using the update_policy_groups_with_http_info variant

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

<Array(, Integer, Hash)> update_policy_groups_with_http_info(id, body)

begin
  # Update Image Assessment Policy Group entities
  data, status_code, headers = api_instance.update_policy_groups_with_http_info(id, body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ModelsPolicyGroupEntityResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->update_policy_groups_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Policy Image Group entity UUID
body ModelsPatchImageGroupRequest

Return type

ModelsPolicyGroupEntityResponse

Authorization

oauth2

HTTP request headers

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

update_policy_precedence

update_policy_precedence(body)

Update Image Assessment Policy precedence

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::ImageAssessmentPolicies.new
body = Falcon::ModelsAPIPrecedenceRequest.new({precedence: ['precedence_example']}) # ModelsAPIPrecedenceRequest | 

begin
  # Update Image Assessment Policy precedence
  result = api_instance.update_policy_precedence(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->update_policy_precedence: #{e}"
end

Using the update_policy_precedence_with_http_info variant

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

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

begin
  # Update Image Assessment Policy precedence
  data, status_code, headers = api_instance.update_policy_precedence_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ModelsPolicyEntityResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ImageAssessmentPolicies->update_policy_precedence_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
body ModelsAPIPrecedenceRequest

Return type

ModelsPolicyEntityResponse

Authorization

oauth2

HTTP request headers

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