Skip to content

Latest commit

 

History

History
369 lines (261 loc) · 10.9 KB

SensorVisibilityExclusions.md

File metadata and controls

369 lines (261 loc) · 10.9 KB

Falcon::SensorVisibilityExclusions

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

Method HTTP request Description
create_sv_exclusions_v1 POST /policy/entities/sv-exclusions/v1 Create the sensor visibility exclusions
delete_sensor_visibility_exclusions_v1 DELETE /policy/entities/sv-exclusions/v1 Delete the sensor visibility exclusions by id
get_sensor_visibility_exclusions_v1 GET /policy/entities/sv-exclusions/v1 Get a set of Sensor Visibility Exclusions by specifying their IDs
query_sensor_visibility_exclusions_v1 GET /policy/queries/sv-exclusions/v1 Search for sensor visibility exclusions.
update_sensor_visibility_exclusions_v1 PATCH /policy/entities/sv-exclusions/v1 Update the sensor visibility exclusions

create_sv_exclusions_v1

create_sv_exclusions_v1(body)

Create the sensor visibility exclusions

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::SensorVisibilityExclusions.new
body = Falcon::SvExclusionsCreateReqV1.new # SvExclusionsCreateReqV1 | 

begin
  # Create the sensor visibility exclusions
  result = api_instance.create_sv_exclusions_v1(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling SensorVisibilityExclusions->create_sv_exclusions_v1: #{e}"
end

Using the create_sv_exclusions_v1_with_http_info variant

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

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

begin
  # Create the sensor visibility exclusions
  data, status_code, headers = api_instance.create_sv_exclusions_v1_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ExclusionsRespV1>
rescue Falcon::ApiError => e
  puts "Error when calling SensorVisibilityExclusions->create_sv_exclusions_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
body SvExclusionsCreateReqV1

Return type

ExclusionsRespV1

Authorization

oauth2

HTTP request headers

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

delete_sensor_visibility_exclusions_v1

delete_sensor_visibility_exclusions_v1(ids, opts)

Delete the sensor visibility exclusions by id

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::SensorVisibilityExclusions.new
ids = ['inner_example'] # Array<String> | The ids of the exclusions to delete
opts = {
  comment: 'comment_example' # String | Explains why this exclusions was deleted
}

begin
  # Delete the sensor visibility exclusions by id
  result = api_instance.delete_sensor_visibility_exclusions_v1(ids, opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling SensorVisibilityExclusions->delete_sensor_visibility_exclusions_v1: #{e}"
end

Using the delete_sensor_visibility_exclusions_v1_with_http_info variant

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

<Array(, Integer, Hash)> delete_sensor_visibility_exclusions_v1_with_http_info(ids, opts)

begin
  # Delete the sensor visibility exclusions by id
  data, status_code, headers = api_instance.delete_sensor_visibility_exclusions_v1_with_http_info(ids, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MsaQueryResponse>
rescue Falcon::ApiError => e
  puts "Error when calling SensorVisibilityExclusions->delete_sensor_visibility_exclusions_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
ids Array<String> The ids of the exclusions to delete
comment String Explains why this exclusions was deleted [optional]

Return type

MsaQueryResponse

Authorization

oauth2

HTTP request headers

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

get_sensor_visibility_exclusions_v1

get_sensor_visibility_exclusions_v1(ids)

Get a set of Sensor Visibility Exclusions by specifying their IDs

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::SensorVisibilityExclusions.new
ids = ['inner_example'] # Array<String> | The ids of the exclusions to retrieve

begin
  # Get a set of Sensor Visibility Exclusions by specifying their IDs
  result = api_instance.get_sensor_visibility_exclusions_v1(ids)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling SensorVisibilityExclusions->get_sensor_visibility_exclusions_v1: #{e}"
end

Using the get_sensor_visibility_exclusions_v1_with_http_info variant

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

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

begin
  # Get a set of Sensor Visibility Exclusions by specifying their IDs
  data, status_code, headers = api_instance.get_sensor_visibility_exclusions_v1_with_http_info(ids)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <SvExclusionsRespV1>
rescue Falcon::ApiError => e
  puts "Error when calling SensorVisibilityExclusions->get_sensor_visibility_exclusions_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
ids Array<String> The ids of the exclusions to retrieve

Return type

SvExclusionsRespV1

Authorization

oauth2

HTTP request headers

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

query_sensor_visibility_exclusions_v1

query_sensor_visibility_exclusions_v1(opts)

Search for sensor visibility exclusions.

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::SensorVisibilityExclusions.new
opts = {
  filter: 'filter_example', # String | The filter expression that should be used to limit the results.
  offset: 56, # Integer | The offset to start retrieving records from
  limit: 56, # Integer | The maximum records to return. [1-500]
  sort: 'applied_globally.asc' # String | The sort expression that should be used to sort the results.
}

begin
  # Search for sensor visibility exclusions.
  result = api_instance.query_sensor_visibility_exclusions_v1(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling SensorVisibilityExclusions->query_sensor_visibility_exclusions_v1: #{e}"
end

Using the query_sensor_visibility_exclusions_v1_with_http_info variant

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

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

begin
  # Search for sensor visibility exclusions.
  data, status_code, headers = api_instance.query_sensor_visibility_exclusions_v1_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MsaQueryResponse>
rescue Falcon::ApiError => e
  puts "Error when calling SensorVisibilityExclusions->query_sensor_visibility_exclusions_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
filter String The filter expression that should be used to limit the results. [optional]
offset Integer The offset to start retrieving records from [optional]
limit Integer The maximum records to return. [1-500] [optional]
sort String The sort expression that should be used to sort the results. [optional]

Return type

MsaQueryResponse

Authorization

oauth2

HTTP request headers

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

update_sensor_visibility_exclusions_v1

update_sensor_visibility_exclusions_v1(body)

Update the sensor visibility exclusions

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::SensorVisibilityExclusions.new
body = Falcon::SvExclusionsUpdateReqV1.new({id: 'id_example'}) # SvExclusionsUpdateReqV1 | 

begin
  # Update the sensor visibility exclusions
  result = api_instance.update_sensor_visibility_exclusions_v1(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling SensorVisibilityExclusions->update_sensor_visibility_exclusions_v1: #{e}"
end

Using the update_sensor_visibility_exclusions_v1_with_http_info variant

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

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

begin
  # Update the sensor visibility exclusions
  data, status_code, headers = api_instance.update_sensor_visibility_exclusions_v1_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <SvExclusionsRespV1>
rescue Falcon::ApiError => e
  puts "Error when calling SensorVisibilityExclusions->update_sensor_visibility_exclusions_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
body SvExclusionsUpdateReqV1

Return type

SvExclusionsRespV1

Authorization

oauth2

HTTP request headers

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