Class: CloudmersiveSecurityApiClient::NetworkThreatDetectionApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-security-api-client/api/network_threat_detection_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ NetworkThreatDetectionApi

Returns a new instance of NetworkThreatDetectionApi.



19
20
21
 
# File 'lib/cloudmersive-security-api-client/api/network_threat_detection_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cloudmersive-security-api-client/api/network_threat_detection_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#network_threat_detection_detect_ssrf_url(request, opts = {}) ⇒ UrlSsrfThreatDetectionResponseFull

Check a URL for Server-side Request Forgery (SSRF) threats Checks if an input URL is at risk of being an SSRF (Server-side request forgery) threat or attack.

Parameters:

  • request —

    Input URL request

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/cloudmersive-security-api-client/api/network_threat_detection_api.rb', line 27

def network_threat_detection_detect_ssrf_url(request, opts = {})
  data, _status_code, _headers = network_threat_detection_detect_ssrf_url_with_http_info(request, opts)
  data
end

#network_threat_detection_detect_ssrf_url_with_http_info(request, opts = {}) ⇒ Array<(UrlSsrfThreatDetectionResponseFull, Fixnum, Hash)>

Check a URL for Server-side Request Forgery (SSRF) threats Checks if an input URL is at risk of being an SSRF (Server-side request forgery) threat or attack.

Parameters:

  • request —

    Input URL request

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

    the optional parameters

Returns:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
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
 
# File 'lib/cloudmersive-security-api-client/api/network_threat_detection_api.rb', line 37

def network_threat_detection_detect_ssrf_url_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkThreatDetectionApi.network_threat_detection_detect_ssrf_url ...'
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling NetworkThreatDetectionApi.network_threat_detection_detect_ssrf_url"
  end
  # resource path
  local_var_path = '/security/threat-detection/network/url/ssrf/detect'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UrlSsrfThreatDetectionResponseFull')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkThreatDetectionApi#network_threat_detection_detect_ssrf_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#network_threat_detection_is_bot(value, opts = {}) ⇒ ThreatDetectionBotCheckResponse

Check if IP address is a Bot client threat Check if the input IP address is a Bot, robot, or otherwise a non-user entity. Leverages real-time signals to check against known high-probability bots..

Parameters:

  • value —

    IP address to check, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:



81
82
83
84
 
# File 'lib/cloudmersive-security-api-client/api/network_threat_detection_api.rb', line 81

def network_threat_detection_is_bot(value, opts = {})
  data, _status_code, _headers = network_threat_detection_is_bot_with_http_info(value, opts)
  data
end

#network_threat_detection_is_bot_with_http_info(value, opts = {}) ⇒ Array<(ThreatDetectionBotCheckResponse, Fixnum, Hash)>

Check if IP address is a Bot client threat Check if the input IP address is a Bot, robot, or otherwise a non-user entity. Leverages real-time signals to check against known high-probability bots..

Parameters:

  • value —

    IP address to check, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/cloudmersive-security-api-client/api/network_threat_detection_api.rb', line 91

def network_threat_detection_is_bot_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkThreatDetectionApi.network_threat_detection_is_bot ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling NetworkThreatDetectionApi.network_threat_detection_is_bot"
  end
  # resource path
  local_var_path = '/security/threat-detection/network/ip/is-bot'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(value)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ThreatDetectionBotCheckResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkThreatDetectionApi#network_threat_detection_is_bot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#network_threat_detection_is_threat(value, opts = {}) ⇒ IPThreatDetectionResponse

Check if IP address is a known threat Check if the input IP address is a known threat IP address. Checks against known bad IPs, botnets, compromised servers, and other lists of threats.

Parameters:

  • value —

    IP address to check, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:



135
136
137
138
 
# File 'lib/cloudmersive-security-api-client/api/network_threat_detection_api.rb', line 135

def network_threat_detection_is_threat(value, opts = {})
  data, _status_code, _headers = network_threat_detection_is_threat_with_http_info(value, opts)
  data
end

#network_threat_detection_is_threat_with_http_info(value, opts = {}) ⇒ Array<(IPThreatDetectionResponse, Fixnum, Hash)>

Check if IP address is a known threat Check if the input IP address is a known threat IP address. Checks against known bad IPs, botnets, compromised servers, and other lists of threats.

Parameters:

  • value —

    IP address to check, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:

  • (Array<(IPThreatDetectionResponse, Fixnum, Hash)>) —

    IPThreatDetectionResponse data, response status code and response headers



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
 
# File 'lib/cloudmersive-security-api-client/api/network_threat_detection_api.rb', line 145

def network_threat_detection_is_threat_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkThreatDetectionApi.network_threat_detection_is_threat ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling NetworkThreatDetectionApi.network_threat_detection_is_threat"
  end
  # resource path
  local_var_path = '/security/threat-detection/network/ip/is-threat'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(value)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IPThreatDetectionResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkThreatDetectionApi#network_threat_detection_is_threat\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#network_threat_detection_is_tor_node(value, opts = {}) ⇒ ThreatDetectionTorNodeResponse

Check if IP address is a Tor node server Check if the input IP address is a Tor exit node server. Tor servers are a type of privacy-preserving technology that can hide the original IP address who makes a request.

Parameters:

  • value —

    IP address to check, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:



189
190
191
192
 
# File 'lib/cloudmersive-security-api-client/api/network_threat_detection_api.rb', line 189

def network_threat_detection_is_tor_node(value, opts = {})
  data, _status_code, _headers = network_threat_detection_is_tor_node_with_http_info(value, opts)
  data
end

#network_threat_detection_is_tor_node_with_http_info(value, opts = {}) ⇒ Array<(ThreatDetectionTorNodeResponse, Fixnum, Hash)>

Check if IP address is a Tor node server Check if the input IP address is a Tor exit node server. Tor servers are a type of privacy-preserving technology that can hide the original IP address who makes a request.

Parameters:

  • value —

    IP address to check, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:



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
237
 
# File 'lib/cloudmersive-security-api-client/api/network_threat_detection_api.rb', line 199

def network_threat_detection_is_tor_node_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NetworkThreatDetectionApi.network_threat_detection_is_tor_node ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling NetworkThreatDetectionApi.network_threat_detection_is_tor_node"
  end
  # resource path
  local_var_path = '/security/threat-detection/network/ip/is-tor-node'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(value)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ThreatDetectionTorNodeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworkThreatDetectionApi#network_threat_detection_is_tor_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end