Class: Falcon::RealTimeResponseApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RealTimeResponseApi

Returns a new instance of RealTimeResponseApi.

[View source]

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

def api_client
  @api_client
end

Instance Method Details

#batch_active_responder_cmd(body, opts = {}) ⇒ DomainMultiCommandExecuteResponseWrapper

Batch executes a RTR active-responder command across the hosts mapped to the given batch ID.

Parameters:

  • body (DomainBatchExecuteCommandRequest) —

    Use this endpoint to run these [real time response commands](falcon.crowdstrike.com/support/documentation/11/getting-started-guide#rtr_commands): - `cat` - `cd` - `clear` - `cp` - `encrypt` - `env` - `eventlog` - `filehash` - `get` - `getsid` - `help` - `history` - `ipconfig` - `kill` - `ls` - `map` - `memdump` - `mkdir` - `mount` - `mv` - `netstat` - `ps` - `reg query` - `reg set` - `reg delete` - `reg load` - `reg unload` - `restart` - `rm` - `runscript` - `shutdown` - `unmap` - `update history` - `update install` - `update list` - `update query` - `xmemdump` - `zip` **`base_command`** Active-Responder command type we are going to execute, for example: `get` or `cp`. Refer to the RTR documentation for the full list of commands. **`batch_id`** Batch ID to execute the command on. Received from `/real-time-response/combined/batch-init-session/v1`. **`command_string`** Full command string for the command. For example `get some_file.txt` **`optional_hosts`** List of a subset of hosts we want to run the command on. If this list is supplied, only these hosts will receive the command.

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

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes. (default to 30)

  • :timeout_duration (String) —

    Timeout duration for how long to wait for the request in duration syntax. Example, `10s`. Valid units: `ns, us, ms, s, m, h`. Maximum is 5 minutes. (default to ‘30s’)

  • :host_timeout_duration (String) —

    Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is < 5 minutes. Example, `10s`. Valid units: `ns, us, ms, s, m, h`. (default to ‘tiny bit less than overall request timeout’)

Returns:

[View source]

46
47
48
49
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 46

def batch_active_responder_cmd(body, opts = {})
  data, _status_code, _headers = batch_active_responder_cmd_with_http_info(body, opts)
  data
end

#batch_active_responder_cmd_with_http_info(body, opts = {}) ⇒ Array<(DomainMultiCommandExecuteResponseWrapper, Integer, Hash)>

Batch executes a RTR active-responder command across the hosts mapped to the given batch ID.

Parameters:

  • body (DomainBatchExecuteCommandRequest) —

    Use this endpoint to run these [real time response commands](falcon.crowdstrike.com/support/documentation/11/getting-started-guide#rtr_commands): - &#x60;cat&#x60; - &#x60;cd&#x60; - &#x60;clear&#x60; - &#x60;cp&#x60; - &#x60;encrypt&#x60; - &#x60;env&#x60; - &#x60;eventlog&#x60; - &#x60;filehash&#x60; - &#x60;get&#x60; - &#x60;getsid&#x60; - &#x60;help&#x60; - &#x60;history&#x60; - &#x60;ipconfig&#x60; - &#x60;kill&#x60; - &#x60;ls&#x60; - &#x60;map&#x60; - &#x60;memdump&#x60; - &#x60;mkdir&#x60; - &#x60;mount&#x60; - &#x60;mv&#x60; - &#x60;netstat&#x60; - &#x60;ps&#x60; - &#x60;reg query&#x60; - &#x60;reg set&#x60; - &#x60;reg delete&#x60; - &#x60;reg load&#x60; - &#x60;reg unload&#x60; - &#x60;restart&#x60; - &#x60;rm&#x60; - &#x60;runscript&#x60; - &#x60;shutdown&#x60; - &#x60;unmap&#x60; - &#x60;update history&#x60; - &#x60;update install&#x60; - &#x60;update list&#x60; - &#x60;update query&#x60; - &#x60;xmemdump&#x60; - &#x60;zip&#x60; **&#x60;base_command&#x60;** Active-Responder command type we are going to execute, for example: &#x60;get&#x60; or &#x60;cp&#x60;. Refer to the RTR documentation for the full list of commands. **&#x60;batch_id&#x60;** Batch ID to execute the command on. Received from &#x60;/real-time-response/combined/batch-init-session/v1&#x60;. **&#x60;command_string&#x60;** Full command string for the command. For example &#x60;get some_file.txt&#x60; **&#x60;optional_hosts&#x60;** List of a subset of hosts we want to run the command on. If this list is supplied, only these hosts will receive the command.

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

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes. (default to 30)

  • :timeout_duration (String) —

    Timeout duration for how long to wait for the request in duration syntax. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. Maximum is 5 minutes. (default to ‘30s’)

  • :host_timeout_duration (String) —

    Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is &lt; 5 minutes. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. (default to ‘tiny bit less than overall request timeout’)

Returns:

[View source]

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
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 58

def batch_active_responder_cmd_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.batch_active_responder_cmd ...'
  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 RealTimeResponseApi.batch_active_responder_cmd"
  end
  # resource path
  local_var_path = '/real-time-response/combined/batch-active-responder-command/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
  query_params[:'timeout_duration'] = opts[:'timeout_duration'] if !opts[:'timeout_duration'].nil?
  query_params[:'host_timeout_duration'] = opts[:'host_timeout_duration'] if !opts[:'host_timeout_duration'].nil?

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

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

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

#batch_cmd(body, opts = {}) ⇒ DomainMultiCommandExecuteResponseWrapper

Batch executes a RTR read-only command across the hosts mapped to the given batch ID.

Parameters:

  • body (DomainBatchExecuteCommandRequest) —

    Use this endpoint to run these [real time response commands](falcon.crowdstrike.com/support/documentation/11/getting-started-guide#rtr_commands): - &#x60;cat&#x60; - &#x60;cd&#x60; - &#x60;clear&#x60; - &#x60;env&#x60; - &#x60;eventlog&#x60; - &#x60;filehash&#x60; - &#x60;getsid&#x60; - &#x60;help&#x60; - &#x60;history&#x60; - &#x60;ipconfig&#x60; - &#x60;ls&#x60; - &#x60;mount&#x60; - &#x60;netstat&#x60; - &#x60;ps&#x60; - &#x60;reg query&#x60; **&#x60;base_command&#x60;** read-only command type we are going to execute, for example: &#x60;ls&#x60; or &#x60;cd&#x60;. Refer to the RTR documentation for the full list of commands. **&#x60;batch_id&#x60;** Batch ID to execute the command on. Received from &#x60;/real-time-response/combined/batch-init-session/v1&#x60;. **&#x60;command_string&#x60;** Full command string for the command. For example &#x60;cd C:\some_directory&#x60; **&#x60;optional_hosts&#x60;** List of a subset of hosts we want to run the command on. If this list is supplied, only these hosts will receive the command.

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

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes. (default to 30)

  • :timeout_duration (String) —

    Timeout duration for how long to wait for the request in duration syntax. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. Maximum is 5 minutes. (default to ‘30s’)

  • :host_timeout_duration (String) —

    Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is &lt; 5 minutes. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. (default to ‘tiny bit less than overall request timeout’)

Returns:

[View source]

121
122
123
124
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 121

def batch_cmd(body, opts = {})
  data, _status_code, _headers = batch_cmd_with_http_info(body, opts)
  data
end

#batch_cmd_with_http_info(body, opts = {}) ⇒ Array<(DomainMultiCommandExecuteResponseWrapper, Integer, Hash)>

Batch executes a RTR read-only command across the hosts mapped to the given batch ID.

Parameters:

  • body (DomainBatchExecuteCommandRequest) —

    Use this endpoint to run these [real time response commands](falcon.crowdstrike.com/support/documentation/11/getting-started-guide#rtr_commands): - &#x60;cat&#x60; - &#x60;cd&#x60; - &#x60;clear&#x60; - &#x60;env&#x60; - &#x60;eventlog&#x60; - &#x60;filehash&#x60; - &#x60;getsid&#x60; - &#x60;help&#x60; - &#x60;history&#x60; - &#x60;ipconfig&#x60; - &#x60;ls&#x60; - &#x60;mount&#x60; - &#x60;netstat&#x60; - &#x60;ps&#x60; - &#x60;reg query&#x60; **&#x60;base_command&#x60;** read-only command type we are going to execute, for example: &#x60;ls&#x60; or &#x60;cd&#x60;. Refer to the RTR documentation for the full list of commands. **&#x60;batch_id&#x60;** Batch ID to execute the command on. Received from &#x60;/real-time-response/combined/batch-init-session/v1&#x60;. **&#x60;command_string&#x60;** Full command string for the command. For example &#x60;cd C:\some_directory&#x60; **&#x60;optional_hosts&#x60;** List of a subset of hosts we want to run the command on. If this list is supplied, only these hosts will receive the command.

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

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes. (default to 30)

  • :timeout_duration (String) —

    Timeout duration for how long to wait for the request in duration syntax. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. Maximum is 5 minutes. (default to ‘30s’)

  • :host_timeout_duration (String) —

    Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is &lt; 5 minutes. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. (default to ‘tiny bit less than overall request timeout’)

Returns:

[View source]

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

def batch_cmd_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.batch_cmd ...'
  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 RealTimeResponseApi.batch_cmd"
  end
  # resource path
  local_var_path = '/real-time-response/combined/batch-command/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
  query_params[:'timeout_duration'] = opts[:'timeout_duration'] if !opts[:'timeout_duration'].nil?
  query_params[:'host_timeout_duration'] = opts[:'host_timeout_duration'] if !opts[:'host_timeout_duration'].nil?

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

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

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

#batch_get_cmd(body, opts = {}) ⇒ DomainBatchGetCommandResponse

Batch executes ‘get` command across hosts to retrieve files. After this call is made `GET /real-time-response/combined/batch-get-command/v1` is used to query for the results.

Parameters:

  • body (DomainBatchGetCommandRequest) —

    **&#x60;batch_id&#x60;** Batch ID to execute the command on. Received from &#x60;/real-time-response/combined/batch-init-session/v1&#x60;. **&#x60;file_path&#x60;** Full path to the file that is to be retrieved from each host in the batch. **&#x60;optional_hosts&#x60;** List of a subset of hosts we want to run the command on. If this list is supplied, only these hosts will receive the command.

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

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes. (default to 30)

  • :timeout_duration (String) —

    Timeout duration for how long to wait for the request in duration syntax. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. Maximum is 5 minutes. (default to ‘30s’)

  • :host_timeout_duration (String) —

    Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is &lt; 5 minutes. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. (default to ‘tiny bit less than overall request timeout’)

Returns:

[View source]

196
197
198
199
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 196

def batch_get_cmd(body, opts = {})
  data, _status_code, _headers = batch_get_cmd_with_http_info(body, opts)
  data
end

#batch_get_cmd_status(batch_get_cmd_req_id, opts = {}) ⇒ DomainBatchGetCmdStatusResponse

Retrieves the status of the specified batch get command. Will return successful files when they are finished processing.

Parameters:

  • batch_get_cmd_req_id (String) —

    Batch Get Command Request ID received from &#x60;/real-time-response/combined/get-command/v1&#x60;

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

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes. (default to 30)

  • :timeout_duration (String) —

    Timeout duration for how long to wait for the request in duration syntax. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. Maximum is 5 minutes. (default to ‘30s’)

Returns:

[View source]

270
271
272
273
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 270

def batch_get_cmd_status(batch_get_cmd_req_id, opts = {})
  data, _status_code, _headers = batch_get_cmd_status_with_http_info(batch_get_cmd_req_id, opts)
  data
end

#batch_get_cmd_status_with_http_info(batch_get_cmd_req_id, opts = {}) ⇒ Array<(DomainBatchGetCmdStatusResponse, Integer, Hash)>

Retrieves the status of the specified batch get command. Will return successful files when they are finished processing.

Parameters:

  • batch_get_cmd_req_id (String) —

    Batch Get Command Request ID received from &#x60;/real-time-response/combined/get-command/v1&#x60;

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

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes. (default to 30)

  • :timeout_duration (String) —

    Timeout duration for how long to wait for the request in duration syntax. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. Maximum is 5 minutes. (default to ‘30s’)

Returns:

[View source]

281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
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
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 281

def batch_get_cmd_status_with_http_info(batch_get_cmd_req_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.batch_get_cmd_status ...'
  end
  # verify the required parameter 'batch_get_cmd_req_id' is set
  if @api_client.config.client_side_validation && batch_get_cmd_req_id.nil?
    fail ArgumentError, "Missing the required parameter 'batch_get_cmd_req_id' when calling RealTimeResponseApi.batch_get_cmd_status"
  end
  # resource path
  local_var_path = '/real-time-response/combined/batch-get-command/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'batch_get_cmd_req_id'] = batch_get_cmd_req_id
  query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
  query_params[:'timeout_duration'] = opts[:'timeout_duration'] if !opts[:'timeout_duration'].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] || 'DomainBatchGetCmdStatusResponse'

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

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

#batch_get_cmd_with_http_info(body, opts = {}) ⇒ Array<(DomainBatchGetCommandResponse, Integer, Hash)>

Batch executes &#x60;get&#x60; command across hosts to retrieve files. After this call is made &#x60;GET /real-time-response/combined/batch-get-command/v1&#x60; is used to query for the results.

Parameters:

  • body (DomainBatchGetCommandRequest) —

    **&#x60;batch_id&#x60;** Batch ID to execute the command on. Received from &#x60;/real-time-response/combined/batch-init-session/v1&#x60;. **&#x60;file_path&#x60;** Full path to the file that is to be retrieved from each host in the batch. **&#x60;optional_hosts&#x60;** List of a subset of hosts we want to run the command on. If this list is supplied, only these hosts will receive the command.

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

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes. (default to 30)

  • :timeout_duration (String) —

    Timeout duration for how long to wait for the request in duration syntax. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. Maximum is 5 minutes. (default to ‘30s’)

  • :host_timeout_duration (String) —

    Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is &lt; 5 minutes. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. (default to ‘tiny bit less than overall request timeout’)

Returns:

[View source]

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

def batch_get_cmd_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.batch_get_cmd ...'
  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 RealTimeResponseApi.batch_get_cmd"
  end
  # resource path
  local_var_path = '/real-time-response/combined/batch-get-command/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
  query_params[:'timeout_duration'] = opts[:'timeout_duration'] if !opts[:'timeout_duration'].nil?
  query_params[:'host_timeout_duration'] = opts[:'host_timeout_duration'] if !opts[:'host_timeout_duration'].nil?

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

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

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

#batch_init_sessions(body, opts = {}) ⇒ DomainBatchInitSessionResponse

Batch initialize a RTR session on multiple hosts. Before any RTR commands can be used, an active session is needed on the host.

Parameters:

  • body (DomainBatchInitSessionRequest) —

    **&#x60;host_ids&#x60;** List of host agent ID&#39;s to initialize a RTR session on. A maximum of 10000 hosts can be in a single batch session. **&#x60;existing_batch_id&#x60;** Optional batch ID. Use an existing batch ID if you want to initialize new hosts and add them to the existing batch **&#x60;queue_offline&#x60;** If we should queue this session if the host is offline. Any commands run against an offline-queued session will be queued up and executed when the host comes online.

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

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes. (default to 30)

  • :timeout_duration (String) —

    Timeout duration for how long to wait for the request in duration syntax. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. Maximum is 5 minutes. (default to ‘30s’)

  • :host_timeout_duration (String) —

    Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is &lt; 5 minutes. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. (default to ‘tiny bit less than overall request timeout’)

Returns:

[View source]

339
340
341
342
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 339

def batch_init_sessions(body, opts = {})
  data, _status_code, _headers = batch_init_sessions_with_http_info(body, opts)
  data
end

#batch_init_sessions_with_http_info(body, opts = {}) ⇒ Array<(DomainBatchInitSessionResponse, Integer, Hash)>

Batch initialize a RTR session on multiple hosts. Before any RTR commands can be used, an active session is needed on the host.

Parameters:

  • body (DomainBatchInitSessionRequest) —

    **&#x60;host_ids&#x60;** List of host agent ID&#39;s to initialize a RTR session on. A maximum of 10000 hosts can be in a single batch session. **&#x60;existing_batch_id&#x60;** Optional batch ID. Use an existing batch ID if you want to initialize new hosts and add them to the existing batch **&#x60;queue_offline&#x60;** If we should queue this session if the host is offline. Any commands run against an offline-queued session will be queued up and executed when the host comes online.

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

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes. (default to 30)

  • :timeout_duration (String) —

    Timeout duration for how long to wait for the request in duration syntax. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. Maximum is 5 minutes. (default to ‘30s’)

  • :host_timeout_duration (String) —

    Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is &lt; 5 minutes. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. (default to ‘tiny bit less than overall request timeout’)

Returns:

[View source]

351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 351

def batch_init_sessions_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.batch_init_sessions ...'
  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 RealTimeResponseApi.batch_init_sessions"
  end
  # resource path
  local_var_path = '/real-time-response/combined/batch-init-session/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
  query_params[:'timeout_duration'] = opts[:'timeout_duration'] if !opts[:'timeout_duration'].nil?
  query_params[:'host_timeout_duration'] = opts[:'host_timeout_duration'] if !opts[:'host_timeout_duration'].nil?

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

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

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

#batch_refresh_sessions(body, opts = {}) ⇒ DomainBatchRefreshSessionResponse

Batch refresh a RTR session on multiple hosts. RTR sessions will expire after 10 minutes unless refreshed.

Parameters:

  • body (DomainBatchRefreshSessionRequest) —

    **&#x60;batch_id&#x60;** Batch ID to execute the command on. Received from &#x60;/real-time-response/combined/batch-init-session/v1&#x60;. **&#x60;hosts_to_remove&#x60;** Hosts to remove from the batch session. Heartbeats will no longer happen on these hosts and the sessions will expire.

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

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes. (default to 30)

  • :timeout_duration (String) —

    Timeout duration for how long to wait for the request in duration syntax. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. Maximum is 5 minutes. (default to ‘30s’)

Returns:

[View source]

413
414
415
416
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 413

def batch_refresh_sessions(body, opts = {})
  data, _status_code, _headers = batch_refresh_sessions_with_http_info(body, opts)
  data
end

#batch_refresh_sessions_with_http_info(body, opts = {}) ⇒ Array<(DomainBatchRefreshSessionResponse, Integer, Hash)>

Batch refresh a RTR session on multiple hosts. RTR sessions will expire after 10 minutes unless refreshed.

Parameters:

  • body (DomainBatchRefreshSessionRequest) —

    **&#x60;batch_id&#x60;** Batch ID to execute the command on. Received from &#x60;/real-time-response/combined/batch-init-session/v1&#x60;. **&#x60;hosts_to_remove&#x60;** Hosts to remove from the batch session. Heartbeats will no longer happen on these hosts and the sessions will expire.

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

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes. (default to 30)

  • :timeout_duration (String) —

    Timeout duration for how long to wait for the request in duration syntax. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. Maximum is 5 minutes. (default to ‘30s’)

Returns:

[View source]

424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 424

def batch_refresh_sessions_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.batch_refresh_sessions ...'
  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 RealTimeResponseApi.batch_refresh_sessions"
  end
  # resource path
  local_var_path = '/real-time-response/combined/batch-refresh-session/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
  query_params[:'timeout_duration'] = opts[:'timeout_duration'] if !opts[:'timeout_duration'].nil?

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

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

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

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

Get aggregates on session data.

Parameters:

  • body (Array<MsaAggregateQueryRequest>) —

    Supported aggregations: - &#x60;term&#x60; - &#x60;date_range&#x60; Supported aggregation members: **&#x60;date_ranges&#x60;** If peforming a date range query specify the **&#x60;from&#x60;** and **&#x60;to&#x60;** date ranges. These can be in common date formats like &#x60;2019-07-18&#x60; or &#x60;now&#x60; **&#x60;field&#x60;** Term you want to aggregate on. If doing a &#x60;date_range&#x60; query, this is the date field you want to apply the date ranges to **&#x60;filter&#x60;** Optional filter criteria in the form of an FQL query. For more information about FQL queries, see our [FQL documentation in Falcon](falcon.crowdstrike.com/support/documentation/45/falcon-query-language-feature-guide). **&#x60;name&#x60;** Name of the aggregation **&#x60;size&#x60;** Size limit to apply to the queries.

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

    the optional parameters

Returns:

[View source]

483
484
485
486
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 483

def r_tr_aggregate_sessions(body, opts = {})
  data, _status_code, _headers = r_tr_aggregate_sessions_with_http_info(body, opts)
  data
end

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

Get aggregates on session data.

Parameters:

  • body (Array<MsaAggregateQueryRequest>) —

    Supported aggregations: - &#x60;term&#x60; - &#x60;date_range&#x60; Supported aggregation members: **&#x60;date_ranges&#x60;** If peforming a date range query specify the **&#x60;from&#x60;** and **&#x60;to&#x60;** date ranges. These can be in common date formats like &#x60;2019-07-18&#x60; or &#x60;now&#x60; **&#x60;field&#x60;** Term you want to aggregate on. If doing a &#x60;date_range&#x60; query, this is the date field you want to apply the date ranges to **&#x60;filter&#x60;** Optional filter criteria in the form of an FQL query. For more information about FQL queries, see our [FQL documentation in Falcon](falcon.crowdstrike.com/support/documentation/45/falcon-query-language-feature-guide). **&#x60;name&#x60;** Name of the aggregation **&#x60;size&#x60;** Size limit to apply to the queries.

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

    the optional parameters

Returns:

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

    MsaAggregatesResponse data, response status code and response headers

[View source]

492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 492

def r_tr_aggregate_sessions_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.r_tr_aggregate_sessions ...'
  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 RealTimeResponseApi.r_tr_aggregate_sessions"
  end
  # resource path
  local_var_path = '/real-time-response/aggregates/sessions/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 => :"RealTimeResponseApi.r_tr_aggregate_sessions",
    :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: RealTimeResponseApi#r_tr_aggregate_sessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#r_tr_check_active_responder_command_status(cloud_request_id, sequence_id, opts = {}) ⇒ DomainStatusResponseWrapper

Get status of an executed active-responder command on a single host.

Parameters:

  • cloud_request_id (String) —

    Cloud Request ID of the executed command to query

  • sequence_id (Integer) —

    Sequence ID that we want to retrieve. Command responses are chunked across sequences

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

    the optional parameters

Returns:

[View source]

550
551
552
553
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 550

def r_tr_check_active_responder_command_status(cloud_request_id, sequence_id, opts = {})
  data, _status_code, _headers = r_tr_check_active_responder_command_status_with_http_info(cloud_request_id, sequence_id, opts)
  data
end

#r_tr_check_active_responder_command_status_with_http_info(cloud_request_id, sequence_id, opts = {}) ⇒ Array<(DomainStatusResponseWrapper, Integer, Hash)>

Get status of an executed active-responder command on a single host.

Parameters:

  • cloud_request_id (String) —

    Cloud Request ID of the executed command to query

  • sequence_id (Integer) —

    Sequence ID that we want to retrieve. Command responses are chunked across sequences

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

    the optional parameters

Returns:

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

    DomainStatusResponseWrapper data, response status code and response headers

[View source]

560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 560

def r_tr_check_active_responder_command_status_with_http_info(cloud_request_id, sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.r_tr_check_active_responder_command_status ...'
  end
  # verify the required parameter 'cloud_request_id' is set
  if @api_client.config.client_side_validation && cloud_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_request_id' when calling RealTimeResponseApi.r_tr_check_active_responder_command_status"
  end
  # verify the required parameter 'sequence_id' is set
  if @api_client.config.client_side_validation && sequence_id.nil?
    fail ArgumentError, "Missing the required parameter 'sequence_id' when calling RealTimeResponseApi.r_tr_check_active_responder_command_status"
  end
  # resource path
  local_var_path = '/real-time-response/entities/active-responder-command/v1'

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

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

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

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

#r_tr_check_command_status(cloud_request_id, sequence_id, opts = {}) ⇒ DomainStatusResponseWrapper

Get status of an executed command on a single host.

Parameters:

  • cloud_request_id (String) —

    Cloud Request ID of the executed command to query

  • sequence_id (Integer) —

    Sequence ID that we want to retrieve. Command responses are chunked across sequences

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

    the optional parameters

Returns:

[View source]

619
620
621
622
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 619

def r_tr_check_command_status(cloud_request_id, sequence_id, opts = {})
  data, _status_code, _headers = r_tr_check_command_status_with_http_info(cloud_request_id, sequence_id, opts)
  data
end

#r_tr_check_command_status_with_http_info(cloud_request_id, sequence_id, opts = {}) ⇒ Array<(DomainStatusResponseWrapper, Integer, Hash)>

Get status of an executed command on a single host.

Parameters:

  • cloud_request_id (String) —

    Cloud Request ID of the executed command to query

  • sequence_id (Integer) —

    Sequence ID that we want to retrieve. Command responses are chunked across sequences

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

    the optional parameters

Returns:

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

    DomainStatusResponseWrapper data, response status code and response headers

[View source]

629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 629

def r_tr_check_command_status_with_http_info(cloud_request_id, sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.r_tr_check_command_status ...'
  end
  # verify the required parameter 'cloud_request_id' is set
  if @api_client.config.client_side_validation && cloud_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_request_id' when calling RealTimeResponseApi.r_tr_check_command_status"
  end
  # verify the required parameter 'sequence_id' is set
  if @api_client.config.client_side_validation && sequence_id.nil?
    fail ArgumentError, "Missing the required parameter 'sequence_id' when calling RealTimeResponseApi.r_tr_check_command_status"
  end
  # resource path
  local_var_path = '/real-time-response/entities/command/v1'

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

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

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

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

#r_tr_delete_file(ids, session_id, opts = {}) ⇒ MsaReplyMetaOnly

Delete a RTR session file.

Parameters:

  • ids (String) —

    RTR Session file id

  • session_id (String) —

    RTR Session id

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

    the optional parameters

Returns:

[View source]

688
689
690
691
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 688

def r_tr_delete_file(ids, session_id, opts = {})
  data, _status_code, _headers = r_tr_delete_file_with_http_info(ids, session_id, opts)
  data
end

#r_tr_delete_file_v2(ids, session_id, opts = {}) ⇒ MsaReplyMetaOnly

Delete a RTR session file.

Parameters:

  • ids (String) —

    RTR Session file id

  • session_id (String) —

    RTR Session id

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

    the optional parameters

Returns:

[View source]

757
758
759
760
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 757

def r_tr_delete_file_v2(ids, session_id, opts = {})
  data, _status_code, _headers = r_tr_delete_file_v2_with_http_info(ids, session_id, opts)
  data
end

#r_tr_delete_file_v2_with_http_info(ids, session_id, opts = {}) ⇒ Array<(MsaReplyMetaOnly, Integer, Hash)>

Delete a RTR session file.

Parameters:

  • ids (String) —

    RTR Session file id

  • session_id (String) —

    RTR Session id

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

    the optional parameters

Returns:

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

    MsaReplyMetaOnly data, response status code and response headers

[View source]

767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 767

def r_tr_delete_file_v2_with_http_info(ids, session_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.r_tr_delete_file_v2 ...'
  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 RealTimeResponseApi.r_tr_delete_file_v2"
  end
  # verify the required parameter 'session_id' is set
  if @api_client.config.client_side_validation && session_id.nil?
    fail ArgumentError, "Missing the required parameter 'session_id' when calling RealTimeResponseApi.r_tr_delete_file_v2"
  end
  # resource path
  local_var_path = '/real-time-response/entities/file/v2'

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

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

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

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

#r_tr_delete_file_with_http_info(ids, session_id, opts = {}) ⇒ Array<(MsaReplyMetaOnly, Integer, Hash)>

Delete a RTR session file.

Parameters:

  • ids (String) —

    RTR Session file id

  • session_id (String) —

    RTR Session id

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

    the optional parameters

Returns:

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

    MsaReplyMetaOnly data, response status code and response headers

[View source]

698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 698

def r_tr_delete_file_with_http_info(ids, session_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.r_tr_delete_file ...'
  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 RealTimeResponseApi.r_tr_delete_file"
  end
  # verify the required parameter 'session_id' is set
  if @api_client.config.client_side_validation && session_id.nil?
    fail ArgumentError, "Missing the required parameter 'session_id' when calling RealTimeResponseApi.r_tr_delete_file"
  end
  # resource path
  local_var_path = '/real-time-response/entities/file/v1'

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

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

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

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

#r_tr_delete_queued_session(session_id, cloud_request_id, opts = {}) ⇒ MsaReplyMetaOnly

Delete a queued session command

Parameters:

  • session_id (String) —

    RTR Session id

  • cloud_request_id (String) —

    Cloud Request ID of the executed command to query

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

    the optional parameters

Returns:

[View source]

826
827
828
829
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 826

def r_tr_delete_queued_session(session_id, cloud_request_id, opts = {})
  data, _status_code, _headers = r_tr_delete_queued_session_with_http_info(session_id, cloud_request_id, opts)
  data
end

#r_tr_delete_queued_session_with_http_info(session_id, cloud_request_id, opts = {}) ⇒ Array<(MsaReplyMetaOnly, Integer, Hash)>

Delete a queued session command

Parameters:

  • session_id (String) —

    RTR Session id

  • cloud_request_id (String) —

    Cloud Request ID of the executed command to query

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

    the optional parameters

Returns:

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

    MsaReplyMetaOnly data, response status code and response headers

[View source]

836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 836

def r_tr_delete_queued_session_with_http_info(session_id, cloud_request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.r_tr_delete_queued_session ...'
  end
  # verify the required parameter 'session_id' is set
  if @api_client.config.client_side_validation && session_id.nil?
    fail ArgumentError, "Missing the required parameter 'session_id' when calling RealTimeResponseApi.r_tr_delete_queued_session"
  end
  # verify the required parameter 'cloud_request_id' is set
  if @api_client.config.client_side_validation && cloud_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_request_id' when calling RealTimeResponseApi.r_tr_delete_queued_session"
  end
  # resource path
  local_var_path = '/real-time-response/entities/queued-sessions/command/v1'

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

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

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

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

#r_tr_delete_session(session_id, opts = {}) ⇒ MsaReplyMetaOnly

Delete a session.

Parameters:

  • session_id (String) —

    RTR Session id

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

    the optional parameters

Returns:

[View source]

894
895
896
897
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 894

def r_tr_delete_session(session_id, opts = {})
  data, _status_code, _headers = r_tr_delete_session_with_http_info(session_id, opts)
  data
end

#r_tr_delete_session_with_http_info(session_id, opts = {}) ⇒ Array<(MsaReplyMetaOnly, Integer, Hash)>

Delete a session.

Parameters:

  • session_id (String) —

    RTR Session id

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

    the optional parameters

Returns:

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

    MsaReplyMetaOnly data, response status code and response headers

[View source]

903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 903

def r_tr_delete_session_with_http_info(session_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.r_tr_delete_session ...'
  end
  # verify the required parameter 'session_id' is set
  if @api_client.config.client_side_validation && session_id.nil?
    fail ArgumentError, "Missing the required parameter 'session_id' when calling RealTimeResponseApi.r_tr_delete_session"
  end
  # resource path
  local_var_path = '/real-time-response/entities/sessions/v1'

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

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

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

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

#r_tr_execute_active_responder_command(body, opts = {}) ⇒ DomainCommandExecuteResponseWrapper

Execute an active responder command on a single host.

Parameters:

  • body (DomainCommandExecuteRequest) —

    Use this endpoint to run these [real time response commands](falcon.crowdstrike.com/support/documentation/11/getting-started-guide#rtr_commands): - &#x60;cat&#x60; - &#x60;cd&#x60; - &#x60;clear&#x60; - &#x60;cp&#x60; - &#x60;encrypt&#x60; - &#x60;env&#x60; - &#x60;eventlog&#x60; - &#x60;filehash&#x60; - &#x60;get&#x60; - &#x60;getsid&#x60; - &#x60;help&#x60; - &#x60;history&#x60; - &#x60;ipconfig&#x60; - &#x60;kill&#x60; - &#x60;ls&#x60; - &#x60;map&#x60; - &#x60;memdump&#x60; - &#x60;mkdir&#x60; - &#x60;mount&#x60; - &#x60;mv&#x60; - &#x60;netstat&#x60; - &#x60;ps&#x60; - &#x60;reg query&#x60; - &#x60;reg set&#x60; - &#x60;reg delete&#x60; - &#x60;reg load&#x60; - &#x60;reg unload&#x60; - &#x60;restart&#x60; - &#x60;rm&#x60; - &#x60;runscript&#x60; - &#x60;shutdown&#x60; - &#x60;unmap&#x60; - &#x60;update history&#x60; - &#x60;update install&#x60; - &#x60;update list&#x60; - &#x60;update query&#x60; - &#x60;xmemdump&#x60; - &#x60;zip&#x60; Required values. The rest of the fields are unused. **&#x60;base_command&#x60;** Active-Responder command type we are going to execute, for example: &#x60;get&#x60; or &#x60;cp&#x60;. Refer to the RTR documentation for the full list of commands. **&#x60;command_string&#x60;** Full command string for the command. For example &#x60;get some_file.txt&#x60; **&#x60;session_id&#x60;** RTR session ID to run the command on

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

    the optional parameters

Returns:

[View source]

956
957
958
959
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 956

def r_tr_execute_active_responder_command(body, opts = {})
  data, _status_code, _headers = r_tr_execute_active_responder_command_with_http_info(body, opts)
  data
end

#r_tr_execute_active_responder_command_with_http_info(body, opts = {}) ⇒ Array<(DomainCommandExecuteResponseWrapper, Integer, Hash)>

Execute an active responder command on a single host.

Parameters:

  • body (DomainCommandExecuteRequest) —

    Use this endpoint to run these [real time response commands](falcon.crowdstrike.com/support/documentation/11/getting-started-guide#rtr_commands): - &#x60;cat&#x60; - &#x60;cd&#x60; - &#x60;clear&#x60; - &#x60;cp&#x60; - &#x60;encrypt&#x60; - &#x60;env&#x60; - &#x60;eventlog&#x60; - &#x60;filehash&#x60; - &#x60;get&#x60; - &#x60;getsid&#x60; - &#x60;help&#x60; - &#x60;history&#x60; - &#x60;ipconfig&#x60; - &#x60;kill&#x60; - &#x60;ls&#x60; - &#x60;map&#x60; - &#x60;memdump&#x60; - &#x60;mkdir&#x60; - &#x60;mount&#x60; - &#x60;mv&#x60; - &#x60;netstat&#x60; - &#x60;ps&#x60; - &#x60;reg query&#x60; - &#x60;reg set&#x60; - &#x60;reg delete&#x60; - &#x60;reg load&#x60; - &#x60;reg unload&#x60; - &#x60;restart&#x60; - &#x60;rm&#x60; - &#x60;runscript&#x60; - &#x60;shutdown&#x60; - &#x60;unmap&#x60; - &#x60;update history&#x60; - &#x60;update install&#x60; - &#x60;update list&#x60; - &#x60;update query&#x60; - &#x60;xmemdump&#x60; - &#x60;zip&#x60; Required values. The rest of the fields are unused. **&#x60;base_command&#x60;** Active-Responder command type we are going to execute, for example: &#x60;get&#x60; or &#x60;cp&#x60;. Refer to the RTR documentation for the full list of commands. **&#x60;command_string&#x60;** Full command string for the command. For example &#x60;get some_file.txt&#x60; **&#x60;session_id&#x60;** RTR session ID to run the command on

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

    the optional parameters

Returns:

[View source]

965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 965

def r_tr_execute_active_responder_command_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.r_tr_execute_active_responder_command ...'
  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 RealTimeResponseApi.r_tr_execute_active_responder_command"
  end
  # resource path
  local_var_path = '/real-time-response/entities/active-responder-command/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] || 'DomainCommandExecuteResponseWrapper'

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

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

#r_tr_execute_command(body, opts = {}) ⇒ DomainCommandExecuteResponseWrapper

Execute a command on a single host.

Parameters:

  • body (DomainCommandExecuteRequest) —

    Use this endpoint to run these [real time response commands](falcon.crowdstrike.com/support/documentation/11/getting-started-guide#rtr_commands): - &#x60;cat&#x60; - &#x60;cd&#x60; - &#x60;clear&#x60; - &#x60;env&#x60; - &#x60;eventlog&#x60; - &#x60;filehash&#x60; - &#x60;getsid&#x60; - &#x60;help&#x60; - &#x60;history&#x60; - &#x60;ipconfig&#x60; - &#x60;ls&#x60; - &#x60;mount&#x60; - &#x60;netstat&#x60; - &#x60;ps&#x60; - &#x60;reg query&#x60; Required values. The rest of the fields are unused. **&#x60;base_command&#x60;** read-only command type we are going to execute, for example: &#x60;ls&#x60; or &#x60;cd&#x60;. Refer to the RTR documentation for the full list of commands. **&#x60;command_string&#x60;** Full command string for the command. For example &#x60;cd C:\some_directory&#x60; **&#x60;session_id&#x60;** RTR session ID to run the command on

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

    the optional parameters

Returns:

[View source]

1022
1023
1024
1025
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1022

def r_tr_execute_command(body, opts = {})
  data, _status_code, _headers = r_tr_execute_command_with_http_info(body, opts)
  data
end

#r_tr_execute_command_with_http_info(body, opts = {}) ⇒ Array<(DomainCommandExecuteResponseWrapper, Integer, Hash)>

Execute a command on a single host.

Parameters:

  • body (DomainCommandExecuteRequest) —

    Use this endpoint to run these [real time response commands](falcon.crowdstrike.com/support/documentation/11/getting-started-guide#rtr_commands): - &#x60;cat&#x60; - &#x60;cd&#x60; - &#x60;clear&#x60; - &#x60;env&#x60; - &#x60;eventlog&#x60; - &#x60;filehash&#x60; - &#x60;getsid&#x60; - &#x60;help&#x60; - &#x60;history&#x60; - &#x60;ipconfig&#x60; - &#x60;ls&#x60; - &#x60;mount&#x60; - &#x60;netstat&#x60; - &#x60;ps&#x60; - &#x60;reg query&#x60; Required values. The rest of the fields are unused. **&#x60;base_command&#x60;** read-only command type we are going to execute, for example: &#x60;ls&#x60; or &#x60;cd&#x60;. Refer to the RTR documentation for the full list of commands. **&#x60;command_string&#x60;** Full command string for the command. For example &#x60;cd C:\some_directory&#x60; **&#x60;session_id&#x60;** RTR session ID to run the command on

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

    the optional parameters

Returns:

[View source]

1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1031

def r_tr_execute_command_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.r_tr_execute_command ...'
  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 RealTimeResponseApi.r_tr_execute_command"
  end
  # resource path
  local_var_path = '/real-time-response/entities/command/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] || 'DomainCommandExecuteResponseWrapper'

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

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

#r_tr_get_extracted_file_contents(session_id, sha256, opts = {}) ⇒ Array<Integer>

Get RTR extracted file contents for specified session and sha256.

Parameters:

  • session_id (String) —

    RTR Session id

  • sha256 (String) —

    Extracted SHA256 (e.g. &#39;efa256a96af3b556cd3fc9d8b1cf587d72807d7805ced441e8149fc279db422b&#39;)

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

    the optional parameters

Options Hash (opts):

  • :filename (String) —

    Filename to use for the archive name and the file within the archive.

Returns:

  • (Array<Integer>)
[View source]

1090
1091
1092
1093
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1090

def r_tr_get_extracted_file_contents(session_id, sha256, opts = {})
  data, _status_code, _headers = r_tr_get_extracted_file_contents_with_http_info(session_id, sha256, opts)
  data
end

#r_tr_get_extracted_file_contents_with_http_info(session_id, sha256, opts = {}) ⇒ Array<(Array<Integer>, Integer, Hash)>

Get RTR extracted file contents for specified session and sha256.

Parameters:

  • session_id (String) —

    RTR Session id

  • sha256 (String) —

    Extracted SHA256 (e.g. &#39;efa256a96af3b556cd3fc9d8b1cf587d72807d7805ced441e8149fc279db422b&#39;)

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

    the optional parameters

Options Hash (opts):

  • :filename (String) —

    Filename to use for the archive name and the file within the archive.

Returns:

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

    Array<Integer> data, response status code and response headers

[View source]

1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1101

def r_tr_get_extracted_file_contents_with_http_info(session_id, sha256, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.r_tr_get_extracted_file_contents ...'
  end
  # verify the required parameter 'session_id' is set
  if @api_client.config.client_side_validation && session_id.nil?
    fail ArgumentError, "Missing the required parameter 'session_id' when calling RealTimeResponseApi.r_tr_get_extracted_file_contents"
  end
  # verify the required parameter 'sha256' is set
  if @api_client.config.client_side_validation && sha256.nil?
    fail ArgumentError, "Missing the required parameter 'sha256' when calling RealTimeResponseApi.r_tr_get_extracted_file_contents"
  end
  # resource path
  local_var_path = '/real-time-response/entities/extracted-file-contents/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'session_id'] = session_id
  query_params[:'sha256'] = sha256
  query_params[:'filename'] = opts[:'filename'] if !opts[:'filename'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/x-7z-compressed', '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] || 'Array<Integer>'

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

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

#r_tr_init_session(body, opts = {}) ⇒ DomainInitResponseWrapper

Initialize a new session with the RTR cloud.

Parameters:

  • body (DomainInitRequest) —

    **&#x60;device_id&#x60;** The host agent ID to initialize the RTR session on. RTR will retrieve an existing session for the calling user on this host **&#x60;queue_offline&#x60;** If we should queue this session if the host is offline. Any commands run against an offline-queued session will be queued up and executed when the host comes online.

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

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes. (default to 30)

  • :timeout_duration (String) —

    Timeout duration for how long to wait for the request in duration syntax. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. Maximum is 5 minutes. (default to ‘30s’)

Returns:

[View source]

1162
1163
1164
1165
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1162

def r_tr_init_session(body, opts = {})
  data, _status_code, _headers = r_tr_init_session_with_http_info(body, opts)
  data
end

#r_tr_init_session_with_http_info(body, opts = {}) ⇒ Array<(DomainInitResponseWrapper, Integer, Hash)>

Initialize a new session with the RTR cloud.

Parameters:

  • body (DomainInitRequest) —

    **&#x60;device_id&#x60;** The host agent ID to initialize the RTR session on. RTR will retrieve an existing session for the calling user on this host **&#x60;queue_offline&#x60;** If we should queue this session if the host is offline. Any commands run against an offline-queued session will be queued up and executed when the host comes online.

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

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes. (default to 30)

  • :timeout_duration (String) —

    Timeout duration for how long to wait for the request in duration syntax. Example, &#x60;10s&#x60;. Valid units: &#x60;ns, us, ms, s, m, h&#x60;. Maximum is 5 minutes. (default to ‘30s’)

Returns:

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

    DomainInitResponseWrapper data, response status code and response headers

[View source]

1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1173

def r_tr_init_session_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.r_tr_init_session ...'
  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 RealTimeResponseApi.r_tr_init_session"
  end
  # resource path
  local_var_path = '/real-time-response/entities/sessions/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
  query_params[:'timeout_duration'] = opts[:'timeout_duration'] if !opts[:'timeout_duration'].nil?

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

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

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

#r_tr_list_all_sessions(opts = {}) ⇒ DomainListSessionsResponseMsa

Get a list of session_ids.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

    Starting index of overall result set from which to return ids.

  • :limit (Integer) —

    Number of ids to return.

  • :sort (String) —

    Sort by spec. Ex: &#39;date_created|asc&#39;.

  • :filter (String) —

    Optional filter criteria in the form of an FQL query. For more information about FQL queries, see our [FQL documentation in Falcon](falcon.crowdstrike.com/support/documentation/45/falcon-query-language-feature-guide). “user_id” can accept a special value ‘@me’ which will restrict results to records with current user’s ID.

Returns:

[View source]

1235
1236
1237
1238
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1235

def r_tr_list_all_sessions(opts = {})
  data, _status_code, _headers = r_tr_list_all_sessions_with_http_info(opts)
  data
end

#r_tr_list_all_sessions_with_http_info(opts = {}) ⇒ Array<(DomainListSessionsResponseMsa, Integer, Hash)>

Get a list of session_ids.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

    Starting index of overall result set from which to return ids.

  • :limit (Integer) —

    Number of ids to return.

  • :sort (String) —

    Sort by spec. Ex: &#39;date_created|asc&#39;.

  • :filter (String) —

    Optional filter criteria in the form of an FQL query. For more information about FQL queries, see our [FQL documentation in Falcon](falcon.crowdstrike.com/support/documentation/45/falcon-query-language-feature-guide). “user_id” can accept a special value ‘@me’ which will restrict results to records with current user’s ID.

Returns:

[View source]

1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1247

def r_tr_list_all_sessions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.r_tr_list_all_sessions ...'
  end
  # resource path
  local_var_path = '/real-time-response/queries/sessions/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] || 'DomainListSessionsResponseMsa'

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

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

#r_tr_list_files(session_id, opts = {}) ⇒ DomainListFilesResponseWrapper

Get a list of files for the specified RTR session.

Parameters:

  • session_id (String) —

    RTR Session id

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

    the optional parameters

Returns:

[View source]

1299
1300
1301
1302
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1299

def r_tr_list_files(session_id, opts = {})
  data, _status_code, _headers = r_tr_list_files_with_http_info(session_id, opts)
  data
end

#r_tr_list_files_v2(session_id, opts = {}) ⇒ DomainListFilesV2ResponseWrapper

Get a list of files for the specified RTR session.

Parameters:

  • session_id (String) —

    RTR Session id

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

    the optional parameters

Returns:

[View source]

1361
1362
1363
1364
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1361

def r_tr_list_files_v2(session_id, opts = {})
  data, _status_code, _headers = r_tr_list_files_v2_with_http_info(session_id, opts)
  data
end

#r_tr_list_files_v2_with_http_info(session_id, opts = {}) ⇒ Array<(DomainListFilesV2ResponseWrapper, Integer, Hash)>

Get a list of files for the specified RTR session.

Parameters:

  • session_id (String) —

    RTR Session id

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

    the optional parameters

Returns:

[View source]

1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1370

def r_tr_list_files_v2_with_http_info(session_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.r_tr_list_files_v2 ...'
  end
  # verify the required parameter 'session_id' is set
  if @api_client.config.client_side_validation && session_id.nil?
    fail ArgumentError, "Missing the required parameter 'session_id' when calling RealTimeResponseApi.r_tr_list_files_v2"
  end
  # resource path
  local_var_path = '/real-time-response/entities/file/v2'

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

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

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

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

#r_tr_list_files_with_http_info(session_id, opts = {}) ⇒ Array<(DomainListFilesResponseWrapper, Integer, Hash)>

Get a list of files for the specified RTR session.

Parameters:

  • session_id (String) —

    RTR Session id

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

    the optional parameters

Returns:

[View source]

1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1308

def r_tr_list_files_with_http_info(session_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.r_tr_list_files ...'
  end
  # verify the required parameter 'session_id' is set
  if @api_client.config.client_side_validation && session_id.nil?
    fail ArgumentError, "Missing the required parameter 'session_id' when calling RealTimeResponseApi.r_tr_list_files"
  end
  # resource path
  local_var_path = '/real-time-response/entities/file/v1'

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

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

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

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

#r_tr_list_queued_sessions(body, opts = {}) ⇒ DomainQueuedSessionResponseWrapper

Get queued session metadata by session ID.

Parameters:

  • body (MsaIdsRequest) —

    **&#x60;ids&#x60;** List of RTR sessions to retrieve. RTR will only return the sessions that were created by the calling user

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

    the optional parameters

Returns:

[View source]

1423
1424
1425
1426
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1423

def r_tr_list_queued_sessions(body, opts = {})
  data, _status_code, _headers = r_tr_list_queued_sessions_with_http_info(body, opts)
  data
end

#r_tr_list_queued_sessions_with_http_info(body, opts = {}) ⇒ Array<(DomainQueuedSessionResponseWrapper, Integer, Hash)>

Get queued session metadata by session ID.

Parameters:

  • body (MsaIdsRequest) —

    **&#x60;ids&#x60;** List of RTR sessions to retrieve. RTR will only return the sessions that were created by the calling user

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

    the optional parameters

Returns:

[View source]

1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1432

def r_tr_list_queued_sessions_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.r_tr_list_queued_sessions ...'
  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 RealTimeResponseApi.r_tr_list_queued_sessions"
  end
  # resource path
  local_var_path = '/real-time-response/entities/queued-sessions/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] || 'DomainQueuedSessionResponseWrapper'

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

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

#r_tr_list_sessions(body, opts = {}) ⇒ DomainSessionResponseWrapper

Get session metadata by session id.

Parameters:

  • body (MsaIdsRequest) —

    **&#x60;ids&#x60;** List of RTR sessions to retrieve. RTR will only return the sessions that were created by the calling user

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

    the optional parameters

Returns:

[View source]

1489
1490
1491
1492
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1489

def r_tr_list_sessions(body, opts = {})
  data, _status_code, _headers = r_tr_list_sessions_with_http_info(body, opts)
  data
end

#r_tr_list_sessions_with_http_info(body, opts = {}) ⇒ Array<(DomainSessionResponseWrapper, Integer, Hash)>

Get session metadata by session id.

Parameters:

  • body (MsaIdsRequest) —

    **&#x60;ids&#x60;** List of RTR sessions to retrieve. RTR will only return the sessions that were created by the calling user

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

    the optional parameters

Returns:

[View source]

1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1498

def r_tr_list_sessions_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.r_tr_list_sessions ...'
  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 RealTimeResponseApi.r_tr_list_sessions"
  end
  # resource path
  local_var_path = '/real-time-response/entities/sessions/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] || 'DomainSessionResponseWrapper'

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

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

#r_tr_pulse_session(body, opts = {}) ⇒ DomainInitResponseWrapper

Refresh a session timeout on a single host.

Parameters:

  • body (DomainInitRequest) —

    **&#x60;device_id&#x60;** The host agent ID to refresh the RTR session on. RTR will retrieve an existing session for the calling user on this host

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

    the optional parameters

Returns:

[View source]

1555
1556
1557
1558
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1555

def r_tr_pulse_session(body, opts = {})
  data, _status_code, _headers = r_tr_pulse_session_with_http_info(body, opts)
  data
end

#r_tr_pulse_session_with_http_info(body, opts = {}) ⇒ Array<(DomainInitResponseWrapper, Integer, Hash)>

Refresh a session timeout on a single host.

Parameters:

  • body (DomainInitRequest) —

    **&#x60;device_id&#x60;** The host agent ID to refresh the RTR session on. RTR will retrieve an existing session for the calling user on this host

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

    the optional parameters

Returns:

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

    DomainInitResponseWrapper data, response status code and response headers

[View source]

1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
 
# File 'lib/crimson-falcon/api/real_time_response_api.rb', line 1564

def r_tr_pulse_session_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeResponseApi.r_tr_pulse_session ...'
  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 RealTimeResponseApi.r_tr_pulse_session"
  end
  # resource path
  local_var_path = '/real-time-response/entities/refresh-session/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] || 'DomainInitResponseWrapper'

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

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