Skip to content

Latest commit

 

History

History
370 lines (262 loc) · 12.3 KB

SensorDownloadApi.md

File metadata and controls

370 lines (262 loc) · 12.3 KB
Raw

Falcon::SensorDownloadApi

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

Method HTTP request Description
download_sensor_installer_by_id GET /sensors/entities/download-installer/v1 Download sensor installer by SHA256 ID
get_combined_sensor_installers_by_query GET /sensors/combined/installers/v1 Get sensor installer details by provided query
get_sensor_installers_by_query GET /sensors/queries/installers/v1 Get sensor installer IDs by provided query
get_sensor_installers_ccidby_query GET /sensors/queries/installers/ccid/v1 Get CCID to use with sensor installers
get_sensor_installers_entities GET /sensors/entities/installers/v1 Get sensor installer details by provided SHA256 IDs

download_sensor_installer_by_id

Object download_sensor_installer_by_id(id)

Download sensor installer by SHA256 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::SensorDownloadApi.new
id = 'id_example' # String | SHA256 of the installer to download

begin
  # Download sensor installer by SHA256 ID
  result = api_instance.download_sensor_installer_by_id(id)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling SensorDownloadApi->download_sensor_installer_by_id: #{e}"
end

Using the download_sensor_installer_by_id_with_http_info variant

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

<Array(Object, Integer, Hash)> download_sensor_installer_by_id_with_http_info(id)

begin
  # Download sensor installer by SHA256 ID
  data, status_code, headers = api_instance.download_sensor_installer_by_id_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Object
rescue Falcon::ApiError => e
  puts "Error when calling SensorDownloadApi->download_sensor_installer_by_id_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String SHA256 of the installer to download

Return type

Object

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/octet-stream

get_combined_sensor_installers_by_query

get_combined_sensor_installers_by_query(opts)

Get sensor installer details by provided query

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::SensorDownloadApi.new
opts = {
  offset: 56, # Integer | The first item to return, where 0 is the latest item. Use with the limit parameter to manage pagination of results.
  limit: 56, # Integer | The number of items to return in this response (default: 100, max: 500). Use with the offset parameter to manage pagination of results.
  sort: 'sort_example', # String | Sort items using their properties. Common sort options include:  <ul><li>version|asc</li><li>release_date|desc</li></ul>
  filter: 'filter_example' # String | Filter items using a query in Falcon Query Language (FQL). An asterisk wildcard * includes all results.  Common filter options include: <ul><li>platform:\"windows\"</li><li>version:>\"5.2\"</li></ul>
}

begin
  # Get sensor installer details by provided query
  result = api_instance.get_combined_sensor_installers_by_query(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling SensorDownloadApi->get_combined_sensor_installers_by_query: #{e}"
end

Using the get_combined_sensor_installers_by_query_with_http_info variant

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

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

begin
  # Get sensor installer details by provided query
  data, status_code, headers = api_instance.get_combined_sensor_installers_by_query_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DomainSensorInstallersV1>
rescue Falcon::ApiError => e
  puts "Error when calling SensorDownloadApi->get_combined_sensor_installers_by_query_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
offset Integer The first item to return, where 0 is the latest item. Use with the limit parameter to manage pagination of results. [optional]
limit Integer The number of items to return in this response (default: 100, max: 500). Use with the offset parameter to manage pagination of results. [optional]
sort String Sort items using their properties. Common sort options include: <ul><li>version asc</li><li>release_date
filter String Filter items using a query in Falcon Query Language (FQL). An asterisk wildcard * includes all results. Common filter options include: <ul><li>platform:&quot;windows&quot;</li><li>version:>&quot;5.2&quot;</li></ul> [optional]

Return type

DomainSensorInstallersV1

Authorization

oauth2

HTTP request headers

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

get_sensor_installers_by_query

get_sensor_installers_by_query(opts)

Get sensor installer IDs by provided query

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::SensorDownloadApi.new
opts = {
  offset: 56, # Integer | The first item to return, where 0 is the latest item. Use with the limit parameter to manage pagination of results.
  limit: 56, # Integer | The number of items to return in this response (default: 100, max: 500). Use with the offset parameter to manage pagination of results.
  sort: 'sort_example', # String | Sort items using their properties. Common sort options include:  <ul><li>version|asc</li><li>release_date|desc</li></ul>
  filter: 'filter_example' # String | Filter items using a query in Falcon Query Language (FQL). An asterisk wildcard * includes all results.  Common filter options include: <ul><li>platform:\"windows\"</li><li>version:>\"5.2\"</li></ul>
}

begin
  # Get sensor installer IDs by provided query
  result = api_instance.get_sensor_installers_by_query(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling SensorDownloadApi->get_sensor_installers_by_query: #{e}"
end

Using the get_sensor_installers_by_query_with_http_info variant

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

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

begin
  # Get sensor installer IDs by provided query
  data, status_code, headers = api_instance.get_sensor_installers_by_query_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MsaspecQueryResponse>
rescue Falcon::ApiError => e
  puts "Error when calling SensorDownloadApi->get_sensor_installers_by_query_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
offset Integer The first item to return, where 0 is the latest item. Use with the limit parameter to manage pagination of results. [optional]
limit Integer The number of items to return in this response (default: 100, max: 500). Use with the offset parameter to manage pagination of results. [optional]
sort String Sort items using their properties. Common sort options include: <ul><li>version asc</li><li>release_date
filter String Filter items using a query in Falcon Query Language (FQL). An asterisk wildcard * includes all results. Common filter options include: <ul><li>platform:&quot;windows&quot;</li><li>version:>&quot;5.2&quot;</li></ul> [optional]

Return type

MsaspecQueryResponse

Authorization

oauth2

HTTP request headers

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

get_sensor_installers_ccidby_query

get_sensor_installers_ccidby_query

Get CCID to use with sensor installers

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

begin
  # Get CCID to use with sensor installers
  result = api_instance.get_sensor_installers_ccidby_query
  p result
rescue Falcon::ApiError => e
  puts "Error when calling SensorDownloadApi->get_sensor_installers_ccidby_query: #{e}"
end

Using the get_sensor_installers_ccidby_query_with_http_info variant

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

<Array(, Integer, Hash)> get_sensor_installers_ccidby_query_with_http_info

begin
  # Get CCID to use with sensor installers
  data, status_code, headers = api_instance.get_sensor_installers_ccidby_query_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MsaspecQueryResponse>
rescue Falcon::ApiError => e
  puts "Error when calling SensorDownloadApi->get_sensor_installers_ccidby_query_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

MsaspecQueryResponse

Authorization

oauth2

HTTP request headers

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

get_sensor_installers_entities

get_sensor_installers_entities(ids)

Get sensor installer details by provided SHA256 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::SensorDownloadApi.new
ids = ['inner_example'] # Array<String> | The IDs of the installers

begin
  # Get sensor installer details by provided SHA256 IDs
  result = api_instance.get_sensor_installers_entities(ids)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling SensorDownloadApi->get_sensor_installers_entities: #{e}"
end

Using the get_sensor_installers_entities_with_http_info variant

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

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

begin
  # Get sensor installer details by provided SHA256 IDs
  data, status_code, headers = api_instance.get_sensor_installers_entities_with_http_info(ids)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DomainSensorInstallersV1>
rescue Falcon::ApiError => e
  puts "Error when calling SensorDownloadApi->get_sensor_installers_entities_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
ids Array<String> The IDs of the installers

Return type

DomainSensorInstallersV1

Authorization

oauth2

HTTP request headers

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