Class: Falcon::SensorDownloadApi

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/sensor_download_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SensorDownloadApi

Returns a new instance of SensorDownloadApi.



36
37
38
 
# File 'lib/crimson-falcon/api/sensor_download_api.rb', line 36

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/crimson-falcon/api/sensor_download_api.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#download_sensor_installer_by_id(id, opts = {}) ⇒ Object

Download sensor installer by SHA256 ID

Parameters:

  • id (String) —

    SHA256 of the installer to download

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


43
44
45
46
 
# File 'lib/crimson-falcon/api/sensor_download_api.rb', line 43

def download_sensor_installer_by_id(id, opts = {})
  data, _status_code, _headers = download_sensor_installer_by_id_with_http_info(id, opts)
  data
end

#download_sensor_installer_by_id_with_http_info(id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Download sensor installer by SHA256 ID

Parameters:

  • id (String) —

    SHA256 of the installer to download

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/crimson-falcon/api/sensor_download_api.rb', line 52

def download_sensor_installer_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorDownloadApi.download_sensor_installer_by_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SensorDownloadApi.download_sensor_installer_by_id"
  end
  # resource path
  local_var_path = '/sensors/entities/download-installer/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/octet-stream'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"SensorDownloadApi.download_sensor_installer_by_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SensorDownloadApi#download_sensor_installer_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_combined_sensor_installers_by_query(opts = {}) ⇒ DomainSensorInstallersV1

Get sensor installer details by provided query

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The first item to return, where 0 is the latest item. Use with the limit parameter to manage pagination of results.

  • :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.

  • :sort (String) —

    Sort items using their properties. Common sort options include: &lt;ul&gt;&lt;li&gt;version|asc&lt;/li&gt;&lt;li&gt;release_date|desc&lt;/li&gt;&lt;/ul&gt;

  • :filter (String) —

    Filter items using a query in Falcon Query Language (FQL). An asterisk wildcard * includes all results. Common filter options include: &lt;ul&gt;&lt;li&gt;platform:&quot;windows&quot;&lt;/li&gt;&lt;li&gt;version:&gt;&quot;5.2&quot;&lt;/li&gt;&lt;/ul&gt;

Returns:



108
109
110
111
 
# File 'lib/crimson-falcon/api/sensor_download_api.rb', line 108

def get_combined_sensor_installers_by_query(opts = {})
  data, _status_code, _headers = get_combined_sensor_installers_by_query_with_http_info(opts)
  data
end

#get_combined_sensor_installers_by_query_with_http_info(opts = {}) ⇒ Array<(DomainSensorInstallersV1, Integer, Hash)>

Get sensor installer details by provided query

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The first item to return, where 0 is the latest item. Use with the limit parameter to manage pagination of results.

  • :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.

  • :sort (String) —

    Sort items using their properties. Common sort options include: &lt;ul&gt;&lt;li&gt;version|asc&lt;/li&gt;&lt;li&gt;release_date|desc&lt;/li&gt;&lt;/ul&gt;

  • :filter (String) —

    Filter items using a query in Falcon Query Language (FQL). An asterisk wildcard * includes all results. Common filter options include: &lt;ul&gt;&lt;li&gt;platform:&quot;windows&quot;&lt;/li&gt;&lt;li&gt;version:&gt;&quot;5.2&quot;&lt;/li&gt;&lt;/ul&gt;

Returns:

  • (Array<(DomainSensorInstallersV1, Integer, Hash)>) —

    DomainSensorInstallersV1 data, response status code and response headers



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/crimson-falcon/api/sensor_download_api.rb', line 120

def get_combined_sensor_installers_by_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorDownloadApi.get_combined_sensor_installers_by_query ...'
  end
  # resource path
  local_var_path = '/sensors/combined/installers/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DomainSensorInstallersV1'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"SensorDownloadApi.get_combined_sensor_installers_by_query",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SensorDownloadApi#get_combined_sensor_installers_by_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sensor_installers_by_query(opts = {}) ⇒ MsaspecQueryResponse

Get sensor installer IDs by provided query

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The first item to return, where 0 is the latest item. Use with the limit parameter to manage pagination of results.

  • :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.

  • :sort (String) —

    Sort items using their properties. Common sort options include: &lt;ul&gt;&lt;li&gt;version|asc&lt;/li&gt;&lt;li&gt;release_date|desc&lt;/li&gt;&lt;/ul&gt;

  • :filter (String) —

    Filter items using a query in Falcon Query Language (FQL). An asterisk wildcard * includes all results. Common filter options include: &lt;ul&gt;&lt;li&gt;platform:&quot;windows&quot;&lt;/li&gt;&lt;li&gt;version:&gt;&quot;5.2&quot;&lt;/li&gt;&lt;/ul&gt;

Returns:



175
176
177
178
 
# File 'lib/crimson-falcon/api/sensor_download_api.rb', line 175

def get_sensor_installers_by_query(opts = {})
  data, _status_code, _headers = get_sensor_installers_by_query_with_http_info(opts)
  data
end

#get_sensor_installers_by_query_with_http_info(opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>

Get sensor installer IDs by provided query

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The first item to return, where 0 is the latest item. Use with the limit parameter to manage pagination of results.

  • :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.

  • :sort (String) —

    Sort items using their properties. Common sort options include: &lt;ul&gt;&lt;li&gt;version|asc&lt;/li&gt;&lt;li&gt;release_date|desc&lt;/li&gt;&lt;/ul&gt;

  • :filter (String) —

    Filter items using a query in Falcon Query Language (FQL). An asterisk wildcard * includes all results. Common filter options include: &lt;ul&gt;&lt;li&gt;platform:&quot;windows&quot;&lt;/li&gt;&lt;li&gt;version:&gt;&quot;5.2&quot;&lt;/li&gt;&lt;/ul&gt;

Returns:

  • (Array<(MsaspecQueryResponse, Integer, Hash)>) —

    MsaspecQueryResponse data, response status code and response headers



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/crimson-falcon/api/sensor_download_api.rb', line 187

def get_sensor_installers_by_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorDownloadApi.get_sensor_installers_by_query ...'
  end
  # resource path
  local_var_path = '/sensors/queries/installers/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MsaspecQueryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"SensorDownloadApi.get_sensor_installers_by_query",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SensorDownloadApi#get_sensor_installers_by_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sensor_installers_ccidby_query(opts = {}) ⇒ MsaspecQueryResponse

Get CCID to use with sensor installers

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



238
239
240
241
 
# File 'lib/crimson-falcon/api/sensor_download_api.rb', line 238

def get_sensor_installers_ccidby_query(opts = {})
  data, _status_code, _headers = get_sensor_installers_ccidby_query_with_http_info(opts)
  data
end

#get_sensor_installers_ccidby_query_with_http_info(opts = {}) ⇒ Array<(MsaspecQueryResponse, Integer, Hash)>

Get CCID to use with sensor installers

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MsaspecQueryResponse, Integer, Hash)>) —

    MsaspecQueryResponse data, response status code and response headers



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/crimson-falcon/api/sensor_download_api.rb', line 246

def get_sensor_installers_ccidby_query_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorDownloadApi.get_sensor_installers_ccidby_query ...'
  end
  # resource path
  local_var_path = '/sensors/queries/installers/ccid/v1'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MsaspecQueryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"SensorDownloadApi.get_sensor_installers_ccidby_query",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SensorDownloadApi#get_sensor_installers_ccidby_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sensor_installers_entities(ids, opts = {}) ⇒ DomainSensorInstallersV1

Get sensor installer details by provided SHA256 IDs

Parameters:

  • ids (Array<String>) —

    The IDs of the installers

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



294
295
296
297
 
# File 'lib/crimson-falcon/api/sensor_download_api.rb', line 294

def get_sensor_installers_entities(ids, opts = {})
  data, _status_code, _headers = get_sensor_installers_entities_with_http_info(ids, opts)
  data
end

#get_sensor_installers_entities_with_http_info(ids, opts = {}) ⇒ Array<(DomainSensorInstallersV1, Integer, Hash)>

Get sensor installer details by provided SHA256 IDs

Parameters:

  • ids (Array<String>) —

    The IDs of the installers

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DomainSensorInstallersV1, Integer, Hash)>) —

    DomainSensorInstallersV1 data, response status code and response headers



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/crimson-falcon/api/sensor_download_api.rb', line 303

def get_sensor_installers_entities_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SensorDownloadApi.get_sensor_installers_entities ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling SensorDownloadApi.get_sensor_installers_entities"
  end
  # resource path
  local_var_path = '/sensors/entities/installers/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DomainSensorInstallersV1'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"SensorDownloadApi.get_sensor_installers_entities",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SensorDownloadApi#get_sensor_installers_entities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end