Class: Falcon::DriftIndicatorsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DriftIndicatorsApi

Returns a new instance of DriftIndicatorsApi.



36
37
38
 
# File 'lib/crimson-falcon/api/drift_indicators_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/drift_indicators_api.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#get_drift_indicators_values_by_date(opts = {}) ⇒ DriftindicatorsDriftIndicatorsFieldValue

Returns the count of Drift Indicators by the date. by default it’s for 7 days.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter drift indicators using a query in Falcon Query Language (FQL). Supported filters: cid,cloud_name,command_line,container_id,file_name,file_sha256,host_id,indicator_process_id,namespace,occurred_at,parent_process_id,pod_name,prevented,scheduler_name,severity,worker_node_name

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve.

Returns:



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

def get_drift_indicators_values_by_date(opts = {})
  data, _status_code, _headers = get_drift_indicators_values_by_date_with_http_info(opts)
  data
end

#get_drift_indicators_values_by_date_with_http_info(opts = {}) ⇒ Array<(DriftindicatorsDriftIndicatorsFieldValue, Integer, Hash)>

Returns the count of Drift Indicators by the date. by default it&#39;s for 7 days.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter drift indicators using a query in Falcon Query Language (FQL). Supported filters: cid,cloud_name,command_line,container_id,file_name,file_sha256,host_id,indicator_process_id,namespace,occurred_at,parent_process_id,pod_name,prevented,scheduler_name,severity,worker_node_name

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve.

Returns:



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
 
# File 'lib/crimson-falcon/api/drift_indicators_api.rb', line 54

def get_drift_indicators_values_by_date_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DriftIndicatorsApi.get_drift_indicators_values_by_date ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/drift-indicators/count-by-date/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'DriftindicatorsDriftIndicatorsFieldValue'

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

  new_options = opts.merge(
    :operation => :"DriftIndicatorsApi.get_drift_indicators_values_by_date",
    :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: DriftIndicatorsApi#get_drift_indicators_values_by_date\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_drift_indicator_entities(opts = {}) ⇒ DriftindicatorsDriftEntityResponse

Retrieve Drift Indicator entities identified by the provided IDs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Search Drift Indicators by ids - The maximum amount is 100 IDs

Returns:



104
105
106
107
 
# File 'lib/crimson-falcon/api/drift_indicators_api.rb', line 104

def read_drift_indicator_entities(opts = {})
  data, _status_code, _headers = read_drift_indicator_entities_with_http_info(opts)
  data
end

#read_drift_indicator_entities_with_http_info(opts = {}) ⇒ Array<(DriftindicatorsDriftEntityResponse, Integer, Hash)>

Retrieve Drift Indicator entities identified by the provided IDs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (Array<String>) —

    Search Drift Indicators by ids - The maximum amount is 100 IDs

Returns:



113
114
115
116
117
118
119
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
 
# File 'lib/crimson-falcon/api/drift_indicators_api.rb', line 113

def read_drift_indicator_entities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DriftIndicatorsApi.read_drift_indicator_entities ...'
  end
  # resource path
  local_var_path = '/container-security/entities/drift-indicators/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].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] || 'DriftindicatorsDriftEntityResponse'

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

  new_options = opts.merge(
    :operation => :"DriftIndicatorsApi.read_drift_indicator_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: DriftIndicatorsApi#read_drift_indicator_entities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_drift_indicators_count(opts = {}) ⇒ DriftindicatorsDriftIndicatorsCountValue

Returns the total count of Drift indicators over a time period

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filters: cid,cloud_name,command_line,container_id,file_name,file_sha256,host_id,indicator_process_id,namespace,occurred_at,parent_process_id,pod_name,prevented,scheduler_name,severity,worker_node_name

Returns:



162
163
164
165
 
# File 'lib/crimson-falcon/api/drift_indicators_api.rb', line 162

def read_drift_indicators_count(opts = {})
  data, _status_code, _headers = read_drift_indicators_count_with_http_info(opts)
  data
end

#read_drift_indicators_count_with_http_info(opts = {}) ⇒ Array<(DriftindicatorsDriftIndicatorsCountValue, Integer, Hash)>

Returns the total count of Drift indicators over a time period

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter images using a query in Falcon Query Language (FQL). Supported filters: cid,cloud_name,command_line,container_id,file_name,file_sha256,host_id,indicator_process_id,namespace,occurred_at,parent_process_id,pod_name,prevented,scheduler_name,severity,worker_node_name

Returns:



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
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
 
# File 'lib/crimson-falcon/api/drift_indicators_api.rb', line 171

def read_drift_indicators_count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DriftIndicatorsApi.read_drift_indicators_count ...'
  end
  # resource path
  local_var_path = '/container-security/aggregates/drift-indicators/count/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  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] || 'DriftindicatorsDriftIndicatorsCountValue'

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

  new_options = opts.merge(
    :operation => :"DriftIndicatorsApi.read_drift_indicators_count",
    :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: DriftIndicatorsApi#read_drift_indicators_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_and_read_drift_indicator_entities(opts = {}) ⇒ DriftindicatorsDriftEntityResponse

Retrieve Drift Indicators by the provided search criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter Drift Indicators using a query in Falcon Query Language (FQL). Supported filters: cid, cloud_name, command_line, container_id, file_name, file_sha256, host_id, indicator_process_id, namespace, occurred_at, parent_process_id, pod_name, prevented, scheduler_name, severity, worker_node_name

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve.

  • :offset (Integer) —

    The offset from where to begin.

  • :sort (String) —

    The fields to sort the records on.

Returns:



223
224
225
226
 
# File 'lib/crimson-falcon/api/drift_indicators_api.rb', line 223

def search_and_read_drift_indicator_entities(opts = {})
  data, _status_code, _headers = search_and_read_drift_indicator_entities_with_http_info(opts)
  data
end

#search_and_read_drift_indicator_entities_with_http_info(opts = {}) ⇒ Array<(DriftindicatorsDriftEntityResponse, Integer, Hash)>

Retrieve Drift Indicators by the provided search criteria

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter Drift Indicators using a query in Falcon Query Language (FQL). Supported filters: cid, cloud_name, command_line, container_id, file_name, file_sha256, host_id, indicator_process_id, namespace, occurred_at, parent_process_id, pod_name, prevented, scheduler_name, severity, worker_node_name

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve.

  • :offset (Integer) —

    The offset from where to begin.

  • :sort (String) —

    The fields to sort the records on.

Returns:



235
236
237
238
239
240
241
242
243
244
245
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
 
# File 'lib/crimson-falcon/api/drift_indicators_api.rb', line 235

def search_and_read_drift_indicator_entities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DriftIndicatorsApi.search_and_read_drift_indicator_entities ...'
  end
  # resource path
  local_var_path = '/container-security/combined/drift-indicators/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'DriftindicatorsDriftEntityResponse'

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

  new_options = opts.merge(
    :operation => :"DriftIndicatorsApi.search_and_read_drift_indicator_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: DriftIndicatorsApi#search_and_read_drift_indicator_entities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_drift_indicators(opts = {}) ⇒ MsaspecQueryResponse

Retrieve all drift indicators that match the given query

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter Drift Indicators using a query in Falcon Query Language (FQL). Supported filters: cid, cloud_name, command_line, container_id, file_name, file_sha256, host_id, indicator_process_id, namespace, occurred_at, parent_process_id, pod_name, prevented, scheduler_name, severity, worker_node_name

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve.

  • :offset (Integer) —

    The offset from where to begin.

  • :sort (String) —

    The fields to sort the records on.

Returns:



290
291
292
293
 
# File 'lib/crimson-falcon/api/drift_indicators_api.rb', line 290

def search_drift_indicators(opts = {})
  data, _status_code, _headers = search_drift_indicators_with_http_info(opts)
  data
end

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

Retrieve all drift indicators that match the given query

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter Drift Indicators using a query in Falcon Query Language (FQL). Supported filters: cid, cloud_name, command_line, container_id, file_name, file_sha256, host_id, indicator_process_id, namespace, occurred_at, parent_process_id, pod_name, prevented, scheduler_name, severity, worker_node_name

  • :limit (Integer) —

    The upper-bound on the number of records to retrieve.

  • :offset (Integer) —

    The offset from where to begin.

  • :sort (String) —

    The fields to sort the records on.

Returns:

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

    MsaspecQueryResponse data, response status code and response headers



302
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
 
# File 'lib/crimson-falcon/api/drift_indicators_api.rb', line 302

def search_drift_indicators_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DriftIndicatorsApi.search_drift_indicators ...'
  end
  # resource path
  local_var_path = '/container-security/queries/drift-indicators/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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 => :"DriftIndicatorsApi.search_drift_indicators",
    :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: DriftIndicatorsApi#search_drift_indicators\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end