Class: Falcon::ApiIntegrations

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ApiIntegrations

Returns a new instance of ApiIntegrations.



35
36
37
 
# File 'lib/crimson-falcon/api/api_integrations.rb', line 35

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



33
34
35
 
# File 'lib/crimson-falcon/api/api_integrations.rb', line 33

def api_client
  @api_client
end

Instance Method Details

#execute_command(resources, opts = {}) ⇒ DomainExecuteCommandResultsV1

Execute a command.

Parameters:

  • resources (Array<DomainExecuteCommandV1>) —

    List of commands to execute

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

    the optional parameters

Returns:



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

def execute_command(resources, opts = {})
  data, _status_code, _headers = execute_command_with_http_info(resources, opts)
  data
end

#execute_command_proxy(body, opts = {}) ⇒ Object

Execute a command and proxy the response directly.

Parameters:

Returns:

  • (Object) 


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

def execute_command_proxy(body, opts = {})
  data, _status_code, _headers = execute_command_proxy_with_http_info(body, opts)
  data
end

#execute_command_proxy_with_http_info(body, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Execute a command and proxy the response directly.

Parameters:

Returns:

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

    Object data, response status code and response headers



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

def execute_command_proxy_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApiIntegrations.execute_command_proxy ...'
  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 ApiIntegrations.execute_command_proxy"
  end
  # resource path
  local_var_path = '/plugins/entities/execute-proxy/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] || 'Object'

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

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

#execute_command_with_http_info(resources, opts = {}) ⇒ Array<(DomainExecuteCommandResultsV1, Integer, Hash)>

Execute a command.

Parameters:

  • resources (Array<DomainExecuteCommandV1>) —

    List of commands to execute

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

    the optional parameters

Returns:



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

def execute_command_with_http_info(resources, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApiIntegrations.execute_command ...'
  end
  # verify the required parameter 'resources' is set
  if @api_client.config.client_side_validation && resources.nil?
    fail ArgumentError, "Missing the required parameter 'resources' when calling ApiIntegrations.execute_command"
  end
  # resource path
  local_var_path = '/plugins/entities/execute/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(['multipart/form-data', 'application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['resources'] = @api_client.build_collection_param(resources, :csv)

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

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

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

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

#get_combined_plugin_configs(opts = {}) ⇒ DomainConfigsV1

Queries for config resources and returns details

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter items using a query in Falcon Query Language (FQL).

  • :limit (Integer) —

    The number of items to return in this response (default: 100, max: 500). Use with the offset parameter to manage pagination of results. (default to 100)

  • :offset (Integer) —

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

  • :sort (String) —

    Sort items using their properties.

Returns:



178
179
180
181
 
# File 'lib/crimson-falcon/api/api_integrations.rb', line 178

def get_combined_plugin_configs(opts = {})
  data, _status_code, _headers = get_combined_plugin_configs_with_http_info(opts)
  data
end

#get_combined_plugin_configs_with_http_info(opts = {}) ⇒ Array<(DomainConfigsV1, Integer, Hash)>

Queries for config resources and returns details

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (String) —

    Filter items using a query in Falcon Query Language (FQL).

  • :limit (Integer) —

    The number of items to return in this response (default: 100, max: 500). Use with the offset parameter to manage pagination of results. (default to 100)

  • :offset (Integer) —

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

  • :sort (String) —

    Sort items using their properties.

Returns:

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

    DomainConfigsV1 data, response status code and response headers



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

def get_combined_plugin_configs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApiIntegrations.get_combined_plugin_configs ...'
  end
  # resource path
  local_var_path = '/plugins/combined/configs/v1'

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

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

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

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

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

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

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