Class: CloudmersiveValidateApiClient::DomainApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DomainApi

Returns a new instance of DomainApi.



19
20
21
 
# File 'lib/cloudmersive-validate-api-client/api/domain_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-validate-api-client/api/domain_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#domain_check(domain, opts = {}) ⇒ CheckResponse

Validate a domain name Check whether a domain name is valid or not. API performs a live validation by contacting DNS services to validate the existence of the domain name.

Parameters:

  • domain —

    Domain name to check, for example "cloudmersive.com". The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:



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

def domain_check(domain, opts = {})
  data, _status_code, _headers = domain_check_with_http_info(domain, opts)
  data
end

#domain_check_with_http_info(domain, opts = {}) ⇒ Array<(CheckResponse, Fixnum, Hash)>

Validate a domain name Check whether a domain name is valid or not. API performs a live validation by contacting DNS services to validate the existence of the domain name.

Parameters:

  • domain —

    Domain name to check, for example &quot;cloudmersive.com&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:

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

    CheckResponse data, response status code and response headers



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-validate-api-client/api/domain_api.rb', line 37

def domain_check_with_http_info(domain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.domain_check ...'
  end
  # verify the required parameter 'domain' is set
  if @api_client.config.client_side_validation && domain.nil?
    fail ArgumentError, "Missing the required parameter 'domain' when calling DomainApi.domain_check"
  end
  # resource path
  local_var_path = '/validate/domain/check'

  # 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(domain)
  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 => 'CheckResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#domain_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domain_get_top_level_domain_from_url(request, opts = {}) ⇒ ValidateUrlResponseSyntaxOnly

Get top-level domain name from URL Gets the top-level domain name from a URL, such as mydomain.com.

Parameters:

  • request —

    Input URL information

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

    the optional parameters

Returns:



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

def domain_get_top_level_domain_from_url(request, opts = {})
  data, _status_code, _headers = domain_get_top_level_domain_from_url_with_http_info(request, opts)
  data
end

#domain_get_top_level_domain_from_url_with_http_info(request, opts = {}) ⇒ Array<(ValidateUrlResponseSyntaxOnly, Fixnum, Hash)>

Get top-level domain name from URL Gets the top-level domain name from a URL, such as mydomain.com.

Parameters:

  • request —

    Input URL information

  • 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-validate-api-client/api/domain_api.rb', line 91

def domain_get_top_level_domain_from_url_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.domain_get_top_level_domain_from_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 DomainApi.domain_get_top_level_domain_from_url"
  end
  # resource path
  local_var_path = '/validate/domain/url/get-top-level-domain'

  # 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 => 'ValidateUrlResponseSyntaxOnly')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#domain_get_top_level_domain_from_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domain_is_admin_path(value, opts = {}) ⇒ IsAdminPathResponse

Check if path is a high-risk or vulnerable server administration path Check if the input URL or relative path is a server Administration Path, and therefore a risk or vulnerability for remote access.

Parameters:

  • value —

    URL or relative path to check, e.g. &quot;/admin/login&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-validate-api-client/api/domain_api.rb', line 135

def domain_is_admin_path(value, opts = {})
  data, _status_code, _headers = domain_is_admin_path_with_http_info(value, opts)
  data
end

#domain_is_admin_path_with_http_info(value, opts = {}) ⇒ Array<(IsAdminPathResponse, Fixnum, Hash)>

Check if path is a high-risk or vulnerable server administration path Check if the input URL or relative path is a server Administration Path, and therefore a risk or vulnerability for remote access.

Parameters:

  • value —

    URL or relative path to check, e.g. &quot;/admin/login&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:

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

    IsAdminPathResponse 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-validate-api-client/api/domain_api.rb', line 145

def domain_is_admin_path_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.domain_is_admin_path ...'
  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 DomainApi.domain_is_admin_path"
  end
  # resource path
  local_var_path = '/validate/domain/url/is-admin-path'

  # 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 => 'IsAdminPathResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#domain_is_admin_path\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domain_phishing_check(request, opts = {}) ⇒ PhishingCheckResponse

Check a URL for Phishing threats Checks if an input URL is at risk of being an Phishing (fake login page, or other page designed to collect information via social engineering) threat or attack.

Parameters:

  • request —

    Input URL request

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

    the optional parameters

Returns:



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

def domain_phishing_check(request, opts = {})
  data, _status_code, _headers = domain_phishing_check_with_http_info(request, opts)
  data
end

#domain_phishing_check_with_http_info(request, opts = {}) ⇒ Array<(PhishingCheckResponse, Fixnum, Hash)>

Check a URL for Phishing threats Checks if an input URL is at risk of being an Phishing (fake login page, or other page designed to collect information via social engineering) threat or attack.

Parameters:

  • request —

    Input URL request

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

    the optional parameters

Returns:

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

    PhishingCheckResponse data, response status code and response headers



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-validate-api-client/api/domain_api.rb', line 199

def domain_phishing_check_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.domain_phishing_check ...'
  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 DomainApi.domain_phishing_check"
  end
  # resource path
  local_var_path = '/validate/domain/url/phishing-threat-check'

  # 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 => 'PhishingCheckResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#domain_phishing_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domain_post(domain, opts = {}) ⇒ WhoisResponse

Get WHOIS information for a domain Validate whether a domain name exists, and also return the full WHOIS record for that domain name. WHOIS records include all the registration details of the domain name, such as information about the domain’s owners.

Parameters:

  • domain —

    Domain name to check, for example &quot;cloudmersive.com&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:



243
244
245
246
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 243

def domain_post(domain, opts = {})
  data, _status_code, _headers = domain_post_with_http_info(domain, opts)
  data
end

#domain_post_with_http_info(domain, opts = {}) ⇒ Array<(WhoisResponse, Fixnum, Hash)>

Get WHOIS information for a domain Validate whether a domain name exists, and also return the full WHOIS record for that domain name. WHOIS records include all the registration details of the domain name, such as information about the domain&#39;s owners.

Parameters:

  • domain —

    Domain name to check, for example &quot;cloudmersive.com&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:

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

    WhoisResponse data, response status code and response headers



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 253

def domain_post_with_http_info(domain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.domain_post ...'
  end
  # verify the required parameter 'domain' is set
  if @api_client.config.client_side_validation && domain.nil?
    fail ArgumentError, "Missing the required parameter 'domain' when calling DomainApi.domain_post"
  end
  # resource path
  local_var_path = '/validate/domain/whois'

  # 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(domain)
  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 => 'WhoisResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#domain_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domain_quality_score(domain, opts = {}) ⇒ DomainQualityResponse

Validate a domain name’s quality score Check the quality of a domain name. Supports over 9 million domain names. Higher quality scores indicate more trust and authority in the domain name, with values ranging from 0.0 (low quality) to 10.0 (maximum quality).

Parameters:

  • domain —

    Domain name to check, for example &quot;cloudmersive.com&quot;.

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

    the optional parameters

Returns:



297
298
299
300
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 297

def domain_quality_score(domain, opts = {})
  data, _status_code, _headers = domain_quality_score_with_http_info(domain, opts)
  data
end

#domain_quality_score_with_http_info(domain, opts = {}) ⇒ Array<(DomainQualityResponse, Fixnum, Hash)>

Validate a domain name&#39;s quality score Check the quality of a domain name. Supports over 9 million domain names. Higher quality scores indicate more trust and authority in the domain name, with values ranging from 0.0 (low quality) to 10.0 (maximum quality).

Parameters:

  • domain —

    Domain name to check, for example &quot;cloudmersive.com&quot;.

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

    the optional parameters

Returns:

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

    DomainQualityResponse data, response status code and response headers



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 307

def domain_quality_score_with_http_info(domain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.domain_quality_score ...'
  end
  # verify the required parameter 'domain' is set
  if @api_client.config.client_side_validation && domain.nil?
    fail ArgumentError, "Missing the required parameter 'domain' when calling DomainApi.domain_quality_score"
  end
  # resource path
  local_var_path = '/validate/domain/quality-score'

  # 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(domain)
  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 => 'DomainQualityResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#domain_quality_score\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domain_safety_check(request, opts = {}) ⇒ UrlSafetyCheckResponseFull

Check a URL for safety threats Checks if an input URL is at risk of being a safety threat through malware, unwanted software, or social engineering threats.

Parameters:

  • request —

    Input URL request

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

    the optional parameters

Returns:



351
352
353
354
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 351

def domain_safety_check(request, opts = {})
  data, _status_code, _headers = domain_safety_check_with_http_info(request, opts)
  data
end

#domain_safety_check_with_http_info(request, opts = {}) ⇒ Array<(UrlSafetyCheckResponseFull, Fixnum, Hash)>

Check a URL for safety threats Checks if an input URL is at risk of being a safety threat through malware, unwanted software, or social engineering threats.

Parameters:

  • request —

    Input URL request

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

    the optional parameters

Returns:

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

    UrlSafetyCheckResponseFull data, response status code and response headers



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
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 361

def domain_safety_check_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.domain_safety_check ...'
  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 DomainApi.domain_safety_check"
  end
  # resource path
  local_var_path = '/validate/domain/url/safety-threat-check'

  # 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 => 'UrlSafetyCheckResponseFull')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#domain_safety_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domain_ssrf_check(request, opts = {}) ⇒ UrlSsrfResponseFull

Check a URL for 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:



405
406
407
408
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 405

def domain_ssrf_check(request, opts = {})
  data, _status_code, _headers = domain_ssrf_check_with_http_info(request, opts)
  data
end

#domain_ssrf_check_batch(request, opts = {}) ⇒ UrlSsrfResponseBatch

Check a URL for SSRF threats in batches Batch-checks if input URLs are at risk of being an SSRF (Server-side request forgery) threat or attack.

Parameters:

  • request —

    Input URL request as a batch of multiple URLs

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

    the optional parameters

Returns:



459
460
461
462
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 459

def domain_ssrf_check_batch(request, opts = {})
  data, _status_code, _headers = domain_ssrf_check_batch_with_http_info(request, opts)
  data
end

#domain_ssrf_check_batch_with_http_info(request, opts = {}) ⇒ Array<(UrlSsrfResponseBatch, Fixnum, Hash)>

Check a URL for SSRF threats in batches Batch-checks if input URLs are at risk of being an SSRF (Server-side request forgery) threat or attack.

Parameters:

  • request —

    Input URL request as a batch of multiple URLs

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

    the optional parameters

Returns:

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

    UrlSsrfResponseBatch data, response status code and response headers



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 469

def domain_ssrf_check_batch_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.domain_ssrf_check_batch ...'
  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 DomainApi.domain_ssrf_check_batch"
  end
  # resource path
  local_var_path = '/validate/domain/url/ssrf-threat-check/batch'

  # 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 => 'UrlSsrfResponseBatch')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#domain_ssrf_check_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domain_ssrf_check_with_http_info(request, opts = {}) ⇒ Array<(UrlSsrfResponseFull, Fixnum, Hash)>

Check a URL for 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:

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

    UrlSsrfResponseFull data, response status code and response headers



415
416
417
418
419
420
421
422
423
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
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 415

def domain_ssrf_check_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.domain_ssrf_check ...'
  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 DomainApi.domain_ssrf_check"
  end
  # resource path
  local_var_path = '/validate/domain/url/ssrf-threat-check'

  # 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 => 'UrlSsrfResponseFull')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#domain_ssrf_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domain_url_full(request, opts = {}) ⇒ ValidateUrlResponseFull

Validate a URL fully Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks. Accepts various types of input and produces a well-formed URL as output.

Parameters:

  • request —

    Input URL request

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

    the optional parameters

Returns:



513
514
515
516
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 513

def domain_url_full(request, opts = {})
  data, _status_code, _headers = domain_url_full_with_http_info(request, opts)
  data
end

#domain_url_full_with_http_info(request, opts = {}) ⇒ Array<(ValidateUrlResponseFull, Fixnum, Hash)>

Validate a URL fully Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks. Accepts various types of input and produces a well-formed URL as output.

Parameters:

  • request —

    Input URL request

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

    the optional parameters

Returns:

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

    ValidateUrlResponseFull data, response status code and response headers



523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 523

def domain_url_full_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.domain_url_full ...'
  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 DomainApi.domain_url_full"
  end
  # resource path
  local_var_path = '/validate/domain/url/full'

  # 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 => 'ValidateUrlResponseFull')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#domain_url_full\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domain_url_html_ssrf_check(request, opts = {}) ⇒ UrlHtmlSsrfResponseFull

Check a URL for HTML embedded SSRF threats Checks if an input URL HTML is at risk of containing one or more embedded SSRF (Server-side request forgery) threats or attacks.

Parameters:

  • request —

    Input URL request

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

    the optional parameters

Returns:



567
568
569
570
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 567

def domain_url_html_ssrf_check(request, opts = {})
  data, _status_code, _headers = domain_url_html_ssrf_check_with_http_info(request, opts)
  data
end

#domain_url_html_ssrf_check_with_http_info(request, opts = {}) ⇒ Array<(UrlHtmlSsrfResponseFull, Fixnum, Hash)>

Check a URL for HTML embedded SSRF threats Checks if an input URL HTML is at risk of containing one or more embedded SSRF (Server-side request forgery) threats or attacks.

Parameters:

  • request —

    Input URL request

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

    the optional parameters

Returns:

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

    UrlHtmlSsrfResponseFull data, response status code and response headers



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
613
614
615
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 577

def domain_url_html_ssrf_check_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.domain_url_html_ssrf_check ...'
  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 DomainApi.domain_url_html_ssrf_check"
  end
  # resource path
  local_var_path = '/validate/domain/url/ssrf-threat-check/html-embedded'

  # 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 => 'UrlHtmlSsrfResponseFull')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#domain_url_html_ssrf_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domain_url_syntax_only(request, opts = {}) ⇒ ValidateUrlResponseSyntaxOnly

Validate a URL syntactically Validate whether a URL is syntactically valid (does not check endpoint for validity). Accepts various types of input and produces a well-formed URL as output.

Parameters:

  • request —

    Input URL information

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

    the optional parameters

Returns:



621
622
623
624
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 621

def domain_url_syntax_only(request, opts = {})
  data, _status_code, _headers = domain_url_syntax_only_with_http_info(request, opts)
  data
end

#domain_url_syntax_only_with_http_info(request, opts = {}) ⇒ Array<(ValidateUrlResponseSyntaxOnly, Fixnum, Hash)>

Validate a URL syntactically Validate whether a URL is syntactically valid (does not check endpoint for validity). Accepts various types of input and produces a well-formed URL as output.

Parameters:

  • request —

    Input URL information

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

    the optional parameters

Returns:



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
 
# File 'lib/cloudmersive-validate-api-client/api/domain_api.rb', line 631

def domain_url_syntax_only_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainApi.domain_url_syntax_only ...'
  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 DomainApi.domain_url_syntax_only"
  end
  # resource path
  local_var_path = '/validate/domain/url/syntax-only'

  # 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 => 'ValidateUrlResponseSyntaxOnly')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DomainApi#domain_url_syntax_only\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end