Class: Falcon::OverwatchDashboard

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OverwatchDashboard

Returns a new instance of OverwatchDashboard.



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

def api_client
  @api_client
end

Instance Method Details

#aggregates_detections_global_counts(filter, opts = {}) ⇒ MsaFacetsResponse

Get the total number of detections pushed across all customers

Parameters:

  • filter (String) —

    An FQL filter string

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

    the optional parameters

Returns:



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

def aggregates_detections_global_counts(filter, opts = {})
  data, _status_code, _headers = aggregates_detections_global_counts_with_http_info(filter, opts)
  data
end

#aggregates_detections_global_counts_with_http_info(filter, opts = {}) ⇒ Array<(MsaFacetsResponse, Integer, Hash)>

Get the total number of detections pushed across all customers

Parameters:

  • filter (String) —

    An FQL filter string

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

    the optional parameters

Returns:

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

    MsaFacetsResponse 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/overwatch_dashboard.rb', line 52

def aggregates_detections_global_counts_with_http_info(filter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OverwatchDashboard.aggregates_detections_global_counts ...'
  end
  # verify the required parameter 'filter' is set
  if @api_client.config.client_side_validation && filter.nil?
    fail ArgumentError, "Missing the required parameter 'filter' when calling OverwatchDashboard.aggregates_detections_global_counts"
  end
  # resource path
  local_var_path = '/overwatch-dashboards/aggregates/detections-global-counts/v1'

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

  # 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] || 'MsaFacetsResponse'

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

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

#aggregates_events(body, opts = {}) ⇒ MsaAggregatesResponse

Get aggregate OverWatch detection event info by providing an aggregate query

Parameters:

Returns:



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

def aggregates_events(body, opts = {})
  data, _status_code, _headers = aggregates_events_with_http_info(body, opts)
  data
end

#aggregates_events_collections(body, opts = {}) ⇒ MsaAggregatesResponse

Get OverWatch detection event collection info by providing an aggregate query

Parameters:

Returns:



171
172
173
174
 
# File 'lib/crimson-falcon/api/overwatch_dashboard.rb', line 171

def aggregates_events_collections(body, opts = {})
  data, _status_code, _headers = aggregates_events_collections_with_http_info(body, opts)
  data
end

#aggregates_events_collections_with_http_info(body, opts = {}) ⇒ Array<(MsaAggregatesResponse, Integer, Hash)>

Get OverWatch detection event collection info by providing an aggregate query

Parameters:

Returns:

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

    MsaAggregatesResponse data, response status code and response headers



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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/crimson-falcon/api/overwatch_dashboard.rb', line 180

def aggregates_events_collections_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OverwatchDashboard.aggregates_events_collections ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling OverwatchDashboard.aggregates_events_collections"
  end
  # resource path
  local_var_path = '/overwatch-dashboards/aggregates/events-collections/GET/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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

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

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

  new_options = opts.merge(
    :operation => :"OverwatchDashboard.aggregates_events_collections",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OverwatchDashboard#aggregates_events_collections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#aggregates_events_with_http_info(body, opts = {}) ⇒ Array<(MsaAggregatesResponse, Integer, Hash)>

Get aggregate OverWatch detection event info by providing an aggregate query

Parameters:

Returns:

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

    MsaAggregatesResponse data, response status code and response headers



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
157
158
159
160
161
162
163
164
165
 
# File 'lib/crimson-falcon/api/overwatch_dashboard.rb', line 114

def aggregates_events_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OverwatchDashboard.aggregates_events ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling OverwatchDashboard.aggregates_events"
  end
  # resource path
  local_var_path = '/overwatch-dashboards/aggregates/events/GET/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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

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

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

  new_options = opts.merge(
    :operation => :"OverwatchDashboard.aggregates_events",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OverwatchDashboard#aggregates_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#aggregates_incidents_global_counts(filter, opts = {}) ⇒ MsaFacetsResponse

Get the total number of incidents pushed across all customers

Parameters:

  • filter (String) —

    An FQL filter string

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

    the optional parameters

Returns:



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

def aggregates_incidents_global_counts(filter, opts = {})
  data, _status_code, _headers = aggregates_incidents_global_counts_with_http_info(filter, opts)
  data
end

#aggregates_incidents_global_counts_with_http_info(filter, opts = {}) ⇒ Array<(MsaFacetsResponse, Integer, Hash)>

Get the total number of incidents pushed across all customers

Parameters:

  • filter (String) —

    An FQL filter string

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

    the optional parameters

Returns:

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

    MsaFacetsResponse 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
289
290
291
292
293
 
# File 'lib/crimson-falcon/api/overwatch_dashboard.rb', line 246

def aggregates_incidents_global_counts_with_http_info(filter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OverwatchDashboard.aggregates_incidents_global_counts ...'
  end
  # verify the required parameter 'filter' is set
  if @api_client.config.client_side_validation && filter.nil?
    fail ArgumentError, "Missing the required parameter 'filter' when calling OverwatchDashboard.aggregates_incidents_global_counts"
  end
  # resource path
  local_var_path = '/overwatch-dashboards/aggregates/incidents-global-counts/v1'

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

  # 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] || 'MsaFacetsResponse'

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

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

#aggregates_ow_events_global_counts(filter, opts = {}) ⇒ MsaFacetsResponse

Get the total number of OverWatch events across all customers

Parameters:

  • filter (String) —

    An FQL filter string

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

    the optional parameters

Returns:



299
300
301
302
 
# File 'lib/crimson-falcon/api/overwatch_dashboard.rb', line 299

def aggregates_ow_events_global_counts(filter, opts = {})
  data, _status_code, _headers = aggregates_ow_events_global_counts_with_http_info(filter, opts)
  data
end

#aggregates_ow_events_global_counts_with_http_info(filter, opts = {}) ⇒ Array<(MsaFacetsResponse, Integer, Hash)>

Get the total number of OverWatch events across all customers

Parameters:

  • filter (String) —

    An FQL filter string

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

    the optional parameters

Returns:

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

    MsaFacetsResponse data, response status code and response headers



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
351
352
353
354
355
 
# File 'lib/crimson-falcon/api/overwatch_dashboard.rb', line 308

def aggregates_ow_events_global_counts_with_http_info(filter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OverwatchDashboard.aggregates_ow_events_global_counts ...'
  end
  # verify the required parameter 'filter' is set
  if @api_client.config.client_side_validation && filter.nil?
    fail ArgumentError, "Missing the required parameter 'filter' when calling OverwatchDashboard.aggregates_ow_events_global_counts"
  end
  # resource path
  local_var_path = '/overwatch-dashboards/aggregates/ow-events-global-counts/v1'

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

  # 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] || 'MsaFacetsResponse'

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

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